Class ExprEquipCompEntities
java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<EntityData>
ch.njol.skript.expressions.base.PropertyExpression<EquippableWrapper,EntityData>
org.skriptlang.skript.bukkit.itemcomponents.equippable.elements.ExprEquipCompEntities
- All Implemented Interfaces:
Debuggable,Expression<EntityData>,Loopable<EntityData>,Simplifiable<Expression<? extends EntityData>>,SyntaxElement,EquippableExperimentSyntax,ExperimentalSyntax,SimpleExperimentalSyntax,RuntimeErrorProducer,SyntaxRuntimeErrorProducer
@Name("Equippable Component - Allowed Entities")
@Description("The entities allowed to wear the item.\nNOTE: Equippable component elements are experimental. Thus, they are subject to change and may not work as intended.\n")
@Example("set the allowed entities of {_item} to a zombie and a skeleton") @Example("set {_component} to the equippable component of {_item}\nclear the allowed entities of {_component}\n")
@RequiredPlugins("Minecraft 1.21.2+")
@Since("2.13")
public class ExprEquipCompEntities
extends ch.njol.skript.expressions.base.PropertyExpression<EquippableWrapper,EntityData>
implements EquippableExperimentSyntax
-
Field Summary
Fields inherited from class ch.njol.skript.expressions.base.PropertyExpression
DEFAULT_PRIORITYFields inherited from interface org.skriptlang.skript.bukkit.itemcomponents.equippable.EquippableExperimentSyntax
EXPERIMENT_DATA -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionClass<?> @Nullable []Tests whether this expression supports the given mode, and if yes what type it expects thedeltato be.voidchange(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode) Changes the expression's value by the given amount.protected EntityData @Nullable []get(org.bukkit.event.Event event, EquippableWrapper[] source) Gets the return type of this expression.booleaninit(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor andSyntaxElement.preInit().booleanisSingle()static voidregister(SyntaxRegistry registry) toString(@Nullable org.bukkit.event.Event event, boolean debug) Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression
get, get, getAll, getAnd, getDefaultPatterns, getExpr, getPatterns, infoBuilder, register, register, registerDefault, registerDefault, setExpr, simplifyMethods inherited from class ch.njol.skript.lang.util.SimpleExpression
check, check, check, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, supportsLoopPeeking, toStringMethods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.skriptlang.skript.bukkit.itemcomponents.equippable.EquippableExperimentSyntax
getExperimentDataMethods inherited from interface ch.njol.skript.lang.Expression
beforeChange, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, possibleReturnTypes, stream, streamAllMethods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer
error, error, getRuntimeErrorManager, warning, warningMethods inherited from interface org.skriptlang.skript.lang.experiment.SimpleExperimentalSyntax
isSatisfiedByMethods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser, preInitMethods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer
getErrorSource
-
Constructor Details
-
ExprEquipCompEntities
public ExprEquipCompEntities()
-
-
Method Details
-
register
-
init
public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Description copied from interface:SyntaxElementCalled just after the constructor andSyntaxElement.preInit().- Specified by:
initin interfaceSyntaxElement- Parameters:
exprs- all %expr%s included in the matching pattern in the order they appear in the pattern. If an optional value was left out, it will still be included in this list holding the default value of the desired type, which usually depends on the event.matchedPattern- The index of the pattern which matchedisDelayed- Whether this expression is used after a delay or not (i.e. if the event has already passed when this expression will be called)parseResult- Additional information about the match.- Returns:
- Whether this expression was initialised successfully. An error should be printed prior to returning false to specify the cause.
- See Also:
-
get
- Specified by:
getin classch.njol.skript.expressions.base.PropertyExpression<EquippableWrapper,EntityData>
-
acceptChange
Description copied from interface:ExpressionTests whether this expression supports the given mode, and if yes what type it expects thedeltato be.Use
Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...)to test whether an expression supports changing, don't directly use this method!Please note that if a changer is registered for this expression's
returnTypethis method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) inExpression.change(Event, Object[], ChangeMode)with super.change(...).Unlike
Changer.acceptChange(ChangeMode)this method may print errors.- Specified by:
acceptChangein interfaceExpression<EntityData>- Overrides:
acceptChangein classSimpleExpression<EntityData>- Parameters:
mode- The mode to check- Returns:
- An array of types that
Expression.change(Event, Object[], ChangeMode)accepts as itsdeltaparameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. ForChanger.ChangeMode.DELETEandChanger.ChangeMode.RESETthis can return any non-null array to mark them as supported.
-
change
public void change(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode) Description copied from interface:ExpressionChanges the expression's value by the given amount. This will only be called on supported modes and with the desireddeltatype as returned byExpression.acceptChange(ChangeMode)- Specified by:
changein interfaceExpression<EntityData>- Overrides:
changein classSimpleExpression<EntityData>- Parameters:
event- The eventdelta- An array with one or more instances of one or more of the classes returned byExpression.acceptChange(ChangeMode)for the given change mode (null forChanger.ChangeMode.DELETEandChanger.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.mode- TheChanger.ChangeModeof the attempted change
-
isSingle
public boolean isSingle()- Specified by:
isSinglein interfaceExpression<EntityData>- Overrides:
isSinglein classch.njol.skript.expressions.base.PropertyExpression<EquippableWrapper,EntityData> - Returns:
- true if this expression will ever only return one value at most, false if it can return multiple values.
-
getReturnType
Description copied from interface:ExpressionGets the return type of this expression.- Specified by:
getReturnTypein interfaceExpression<EntityData>- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)and the component type of any arrays returned byExpression.getArray(Event)
-
toString
- Specified by:
toStringin interfaceDebuggable- Parameters:
event- The event to get information from. This is always null if debug == false.debug- If true this should print more information, if false this should print what is shown to the end user- Returns:
- String representation of this object
-