Package ch.njol.skript.expressions

Class ExprNamed

java.lang.Object
ch.njol.skript.lang.util.SimpleExpression<T>
ch.njol.skript.expressions.base.PropertyExpression<Object,​Object>
ch.njol.skript.expressions.ExprNamed
All Implemented Interfaces:
Debuggable, Expression<Object>, SyntaxElement
@Name("Named Item/Inventory/Entities") @Description("Directly names an item/inventory/entity, useful for defining a named item/inventory/entity in a script. If you want to (re)name existing items/inventories you can either use this expression or use <a href=\'#ExprName\'>Name Of</a> expression.") @Examples({"give a diamond sword of sharpness 100 named \"&lt;gold&gt;Excalibur\" to the player","set tool of player to the player\'s tool named \"&lt;gold&gt;Wand\"","set the name of the player\'s tool to \"&lt;gold&gt;Wand\"","spawn creeper named \"Bob\" at player","open hopper inventory named \"Magic Hopper\" to player"}) @Since("2.0, 2.2-dev34 (inventories), INSERT VERSION (entities)") public class ExprNamed extends PropertyExpression<Object,​Object>

  • Constructor Details

    • ExprNamed

      public ExprNamed()

  • 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 Object[] get​(org.bukkit.event.Event e, Object[] 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<Object,​Object>
      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 Object> 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