Package ch.njol.skript.expressions

Class ExprColoured

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.base.PropertyExpression<String,​String>
ch.njol.skript.expressions.ExprColoured
All Implemented Interfaces:
Debuggable, Expression<String>, SyntaxElement
@Name("Coloured / Uncoloured") @Description({"Parses &lt;colour&gt;s and, optionally, chat styles in a message or removes","any colours <i>and</i> chat styles from the message. Parsing all","chat styles requires this expression to be used in same line with","the <a href=effects.html#EffSend>send effect</a>."}) @Examples({"on chat:","\tset message to coloured message # Safe; only colors get parsed","command /fade &lt;player&gt;:","\ttrigger:","\t\tset display name of the player-argument to uncoloured display name of the player-argument","command /format &lt;text&gt;:","\ttrigger:","\t\tmessage formatted text-argument # Safe, because we\'re sending to whoever used this command"}) @Since("2.0") public class ExprColoured extends PropertyExpression<String,​String>

  • Constructor Details

    • ExprColoured

      public ExprColoured()

  • 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.
      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:
      ParserInstance.isCurrentEvent(Class...)

    • get

      protected String[] get​(org.bukkit.event.Event e, String[] source)
      Description copied from class: PropertyExpression
      Converts the given source object(s) to the correct type.

      Please note that the returned array must neither be null nor contain any null elements!

      Specified by:
      get in class PropertyExpression<String,​String>
      Returns:
      An array of the converted objects, which may contain less elements than the source array, but must not be null.
      See Also:
      Converters.convert(Object[], Class, Converter)

    • getReturnType

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

    • toString

      public String toString​(@Nullable org.bukkit.event.Event e, boolean debug)
      Parameters:
      e - The event to get information to. 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

    • isUnsafeFormat

      public boolean isUnsafeFormat()
      If parent of this expression should try to parse all styles instead of just colors. This is unsafe to do with untrusted user input.
      Returns:
      If unsafe formatting was requested in script.