Package org.skriptlang.skript.common.expressions

Class ExprColorFromHexCode

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Color>
ch.njol.skript.expressions.base.PropertyExpression<String,Color>
ch.njol.skript.expressions.base.SimplePropertyExpression<String,Color>
org.skriptlang.skript.common.expressions.ExprColorFromHexCode
All Implemented Interfaces:
Debuggable, Expression<Color>, Loopable<Color>, Simplifiable<Expression<? extends Color>>, SyntaxElement, Converter<String,Color>, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Color from Hex Code") @Description("Returns a proper argb color from a hex code string. The hex code must contain RRGGBB values, but can also contain a leading # or AARRGGBB format. Invalid codes will cause runtime errors.") @Example("send color from hex code \"#FFBBA7\"") @Example("send color from hex code \"FFBBA7\"") @Example("send color from hex code \"#AAFFBBA7\"") @Since("2.14") public class ExprColorFromHexCode extends ch.njol.skript.expressions.base.SimplePropertyExpression<String,Color>

  • Constructor Details

    • ExprColorFromHexCode

      public ExprColorFromHexCode()

  • Method Details

    • convert

      @Nullable public @Nullable Color convert(String from)
      Description copied from interface: Converter
      Converts an object using this Converter.
      Specified by:
      convert in interface Converter<String,Color>
      Specified by:
      convert in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Color>
      Parameters:
      from - The object to convert.
      Returns:
      The converted object.

    • getReturnType

      public Class<? extends Color> 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)

    • getPropertyName

      protected String getPropertyName()
      Specified by:
      getPropertyName in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Color>

    • toString

      public String toString(@Nullable @Nullable org.bukkit.event.Event event, boolean debug)
      Specified by:
      toString in interface Debuggable
      Overrides:
      toString in class ch.njol.skript.expressions.base.SimplePropertyExpression<String,Color>
      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

    • simplify

      public Expression<? extends Color> 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<Color>
      Specified by:
      simplify in interface Simplifiable<Expression<? extends Color>>
      Overrides:
      simplify in class ch.njol.skript.expressions.base.PropertyExpression<String,Color>
      Returns:
      the simplified object.
      See Also: