Package org.skriptlang.skript.bukkit.misc.expressions

Class ExprRotate

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Object>
org.skriptlang.skript.bukkit.misc.expressions.ExprRotate
All Implemented Interfaces:
Debuggable, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Rotated Quaternion/Vector") @Description({"Rotates a quaternion or vector around an axis a set amount of degrees, or around all 3 axes at once.","Vectors can only be rotated around the global X/Y/Z axes, or an arbitrary vector axis.","Quaternions are more flexible, allowing rotation around the global or local X/Y/Z axes, arbitrary vectors, or all 3 local axes at once.","Global axes are the ones in the Minecraft world. Local axes are relative to how the quaternion is already oriented.","","Note that rotating a quaternion around a vector results in a rotation around the local vector, so results may not be what you expect. For example, rotating around vector(1, 0, 0) is the same as rotating around the local X axis.","The same applies to rotations by all three axes at once. In addition, rotating around all three axes of a quaternion/display at once will rotate in ZYX order, meaning the Z rotation will be applied first and the X rotation last."}) @Examples({"set {_new} to {_quaternion} rotated around x axis by 10 degrees","set {_new} to {_vector} rotated around vector(1, 1, 1) by 45","set {_new} to {_quaternion} rotated by x 45, y 90, z 135"}) @Since("2.10") public class ExprRotate extends SimpleExpression<Object>

  • Constructor Details

    • ExprRotate

      public ExprRotate()

  • Method Details

    • init

      public boolean init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)
      Description copied from interface: SyntaxElement
      Called just after the constructor and SyntaxElement.preInit().
      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 matched
      isDelayed - 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

      @Nullable protected @Nullable Object[] get(org.bukkit.event.Event event)
      Description copied from class: SimpleExpression
      This is the internal method to get an expression's values.
      To get the expression's value from the outside use SimpleExpression.getSingle(Event) or SimpleExpression.getArray(Event).
      Specified by:
      get in class SimpleExpression<Object>
      Parameters:
      event - The event with which this expression is evaluated.
      Returns:
      An array of values for this event. May not contain nulls.

    • isSingle

      public boolean isSingle()
      Returns:
      true if this expression will ever only return one value at most, false if it can return multiple values.

    • getReturnType

      public Class<?> 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 by Expression.getArray(Event)

    • possibleReturnTypes

      public Class<?>[] possibleReturnTypes()
      Description copied from interface: Expression
      For expressions that might return multiple (incalculable at parse time) types, this provides a list of all possible types. Use cases include: expressions that depend on the return type of their input.
      Returns:
      A list of all possible types this might return

    • simplify

      public Expression<?> simplify()
      Description copied from interface: Simplifiable
      Simplifies this object. This should be called immediately after init() returns true. If simplification is not possible, the object is returned as is.
      References to the original object should be replaced with the simplified object.
      Any returned object should attempt to maintain the original value of Debuggable.toString(Event, boolean). An addition indicating that the value was simplified can be added in the debug string. See SimplifiedLiteral for an example.
      Simplification should never invalidate contracts. For example, any simplified expression should take care to return the same or a more specific type than the original expression, never a more generic type. Likewise, be sure to maintain the behavior of change() and acceptsChange(). Failure to do so can result in unexpected behavior and tricky bugs.
      Finally, simplified results should update Expression.getSource() to point to the expression prior to simplification. This makes maintaining the above contracts easier.
      Specified by:
      simplify in interface Expression<Object>
      Specified by:
      simplify in interface Simplifiable<Expression<? extends Object>>
      Overrides:
      simplify in class SimpleExpression<Object>
      Returns:
      the simplified object.
      See Also:

    • toString

      public String toString(@Nullable @Nullable org.bukkit.event.Event event, boolean debug)
      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