Class ExprRawString

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<Object>
ch.njol.skript.expressions.base.PropertyExpression<String,Object>
ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>
org.skriptlang.skript.bukkit.text.elements.expressions.ExprRawString
All Implemented Interfaces:
Debuggable, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, Converter<String,Object>, RuntimeErrorProducer, SyntaxRuntimeErrorProducer
@Name("Raw String") @Description({"Returns the string without formatting (colors, decorations, etc.) and without stripping them from it.","For example, <code>raw \"&aHello There!\"</code> would output <code>&aHello There!</code>"}) @Example("send raw \"&aThis text is unformatted!\" to all players") @Since("2.7") public class ExprRawString extends ch.njol.skript.expressions.base.SimplePropertyExpression<String,Object>

  • Constructor Details

    • ExprRawString

      public ExprRawString()

  • Method Details

    • register

      public static void register(SyntaxRegistry syntaxRegistry)

    • convert

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

    • 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)

    • getPropertyName

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

    • getConvertedExpression

      @SafeVarargs @Nullable public final <R> @Nullable Expression<? extends R> getConvertedExpression(Class<R>... to)
      Description copied from class: SimpleExpression
      Usually, you want to override SimpleExpression.getConvertedExpr(Class[]). However, it may be useful to override this method if you have an expression with a return type that is unknown until runtime (like variables). Usually, you'll be fine with just the default implementation. This method is final on versions below 2.2-dev36.
      Specified by:
      getConvertedExpression in interface Expression<Object>
      Overrides:
      getConvertedExpression in class SimpleExpression<Object>
      Parameters:
      to - The desired return type of the returned expression
      Returns:
      The converted expression
      See Also:

    • 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 ch.njol.skript.expressions.base.PropertyExpression<String,Object>
      Returns:
      the simplified object.
      See Also: