Package ch.njol.skript.classes

Interface Changer<T>

All Known Implementing Classes:

BlockClassInfo.BlockChanger, EntityClassInfo.EntityChanger, InventoryClassInfo.InventoryChanger, PlayerClassInfo.PlayerChanger, SlotClassInfo.SlotChanger

public interface Changer<T>

An interface to declare changeable values. All Expressions implement something similar like this by default, but refuse any change if Expression.acceptChange(ChangeMode) isn't overridden.

Some useful Changers can be found in DefaultChangers

See Also:

• DefaultChangers
• Expression

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	Changer.ChangeMode
static class	Changer.ChangerUtils

Method Summary

Modifier and Type	Method	Description
Class<?> @Nullable []	acceptChange(Changer.ChangeMode mode)	Tests whether this changer supports the given mode, and if yes what type(s) it expects the elements of delta to be.
void	change(T[] what, Object @Nullable [] delta, Changer.ChangeMode mode)

Method Details

acceptChange

Class<?> @Nullable [] acceptChange(Changer.ChangeMode mode)

Tests whether this changer supports the given mode, and if yes what type(s) it expects the elements of delta to be.

Unlike Expression.acceptChange(ChangeMode) this method must not print errors.

Parameters:

mode - The Changer.ChangeMode to test.

Returns:

An array of types that change(Object[], Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

change

void change(T[] what,
 Object @Nullable [] delta,
 Changer.ChangeMode mode)

Parameters:

what - The objects to change

delta - An array with one or more instances of one or more of the the classes returned by acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

mode - The Changer.ChangeMode to test.

Throws:

UnsupportedOperationException - (optional) if this method was called on an unsupported ChangeMode.