Class ExprQuaternionAxisAngle
- All Implemented Interfaces:
Converter<org.joml.Quaternionf,
,Object> Debuggable
,Expression<Object>
,SyntaxElement
@Name("Rotation Axis/Angle")
@Description({"Returns the axis or angle that a quaternion will rotate by/around.","All quaternions can be represented by a rotation of some amount around some axis, so this expression provides the ability to get that angle/axis."})
@Examples({"set {_quaternion} to axisAngle(45, vector(1, 2, 3))","send rotation axis of {_quaternion} # 1, 2, 3","send rotation angle of {_quaternion} # 45","set rotation angle of {_quaternion} to 135","set rotation axis of {_quaternion} to vector(0, 1, 0)"})
@Since("2.10.0")
public class ExprQuaternionAxisAngle
extends ch.njol.skript.expressions.base.SimplePropertyExpression<org.joml.Quaternionf,Object>
-
Nested Class Summary
Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter
Converter.ConverterInfo<F,
T>, Converter.ConverterUtils -
Field Summary
Fields inherited from interface ch.njol.skript.classes.Converter
NO_CHAINING, NO_COMMAND_ARGUMENTS, NO_LEFT_CHAINING, NO_RIGHT_CHAINING
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionClass<?> @Nullable []
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
to be.void
change
(org.bukkit.event.Event event, Object @Nullable [] delta, Changer.ChangeMode mode) Changes the expression's value by the given amount.@Nullable Object
convert
(org.joml.Quaternionf from) Converts an object from the given to the desired type.protected String
Class
<?> Gets the return type of this expression.boolean
init
(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Called just after the constructor.Methods inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression
get, toString
Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression
get, get, getAll, getAnd, getDefaultPatterns, getExpr, getPatterns, isSingle, register, registerDefault, setExpr, simplify
Methods inherited from class ch.njol.skript.lang.util.SimpleExpression
check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, setTime, toString
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface ch.njol.skript.lang.Expression
beforeChange, canBeSingle, canReturn, getAcceptedChangeModes, getOptionalSingle, possibleReturnTypes, stream
Methods inherited from interface ch.njol.skript.lang.SyntaxElement
getParser
-
Constructor Details
-
ExprQuaternionAxisAngle
public ExprQuaternionAxisAngle()
-
-
Method Details
-
init
public boolean init(Expression<?>[] expressions, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult) Description copied from interface:SyntaxElement
Called just after the constructor.- Specified by:
init
in interfaceSyntaxElement
- Overrides:
init
in classch.njol.skript.expressions.base.SimplePropertyExpression<org.joml.Quaternionf,
Object> - Parameters:
expressions
- 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:
-
convert
Description copied from interface:Converter
Converts an object from the given to the desired type. -
acceptChange
Description copied from interface:Expression
Tests whether this expression supports the given mode, and if yes what type it expects thedelta
to 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
returnType
this 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:
acceptChange
in interfaceExpression<Object>
- Overrides:
acceptChange
in classSimpleExpression<Object>
- Parameters:
mode
- The mode to check- Returns:
- An array of types that
Expression.change(Event, Object[], ChangeMode)
accepts as itsdelta
parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. ForChanger.ChangeMode.DELETE
andChanger.ChangeMode.RESET
this 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:Expression
Changes the expression's value by the given amount. This will only be called on supported modes and with the desireddelta
type as returned byExpression.acceptChange(ChangeMode)
- Specified by:
change
in interfaceExpression<Object>
- Overrides:
change
in classSimpleExpression<Object>
- 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.DELETE
andChanger.ChangeMode.RESET
). This can be a Object[], thus casting is not allowed.mode
- TheChanger.ChangeMode
of the attempted change
-
getReturnType
Description copied from interface:Expression
Gets the return type of this expression.- Returns:
- A supertype of any objects returned by
Expression.getSingle(Event)
and the component type of any arrays returned byExpression.getArray(Event)
-
getPropertyName
- Specified by:
getPropertyName
in classch.njol.skript.expressions.base.SimplePropertyExpression<org.joml.Quaternionf,
Object>
-