Package ch.njol.skript.expressions

Class ExprName

java.lang.Object

ch.njol.skript.lang.util.SimpleExpression<T>

ch.njol.skript.expressions.base.PropertyExpression<F,T>

ch.njol.skript.expressions.base.SimplePropertyExpression<Object,String>

ch.njol.skript.expressions.ExprName

All Implemented Interfaces:

Converter<Object,String>, Debuggable, Expression<String>, SyntaxElement

@Name("Name / Display Name / Tab List Name")
@Description({"Represents the Minecraft account, display or tab list name of a player, or the custom name of an item, entity, block, inventory, or gamerule.","","<ul>","\t<li><strong>Players</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The Minecraft account name of the player. Can\'t be changed, but \'display name\' can be changed.</li>","\t\t\t<li><strong>Display Name:</strong> The name of the player that is displayed in messages. This name can be changed freely and can include colour codes, and is shared among all plugins (e.g. chat plugins will use the display name).</li>","\t\t</ul>","\t</li>","\t<li><strong>Entities</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The custom name of the entity. Can be changed. But for living entities, the players will have to target the entity to see its name tag. For non-living entities, the name will not be visible at all. To prevent this, use \'display name\'.</li>","\t\t\t<li><strong>Display Name:</strong> The custom name of the entity. Can be changed, which will also enable <em>custom name visibility</em> of the entity so name tag of the entity will be visible always.</li>","\t\t</ul>","\t</li>","\t<li><strong>Items</strong>","\t\t<ul>","\t\t\t<li><strong>Name and Display Name:</strong> The <em>custom</em> name of the item (not the Minecraft locale name). Can be changed.</li>","\t\t</ul>","\t</li>","\t<li><strong>Inventories</strong>","\t\t<ul>","\t\t\t<li><strong>Name and Display Name:</strong> The name/title of the inventory. Changing name of an inventory means opening the same inventory with the same contents but with a different name to its current viewers.</li>","\t\t</ul>","\t</li>","\t<li><strong>Gamerules (1.13+)</strong>","\t\t<ul>","\t\t\t<li><strong>Name:</strong> The name of the gamerule. Cannot be changed.</li>","\t\t</ul>","\t</li>","</ul>"})
@Examples({"on join:","\tplayer has permission \"name.red\"","\tset the player\'s display name to \"&lt;red&gt;[admin] &lt;gold&gt;%name of player%\"","\tset the player\'s tab list name to \"&lt;green&gt;%player\'s name%\"","set the name of the player\'s tool to \"Legendary Sword of Awesomeness\""})
@Since("before 2.1, 2.2-dev20 (inventory name), 2.4 (non-living entity support, changeable inventory name)")
public class ExprName
extends SimplePropertyExpression<Object,String>

Nested Class Summary

Nested classes/interfaces inherited from interface ch.njol.skript.classes.Converter

Converter.ConverterInfo<F,T>, Converter.ConverterUtils

Field Summary

Fields inherited from interface ch.njol.skript.classes.Converter

NO_CHAINING, NO_COMMAND_ARGUMENTS, NO_LEFT_CHAINING, NO_RIGHT_CHAINING

Constructor Summary

Constructors

Constructor	Description
ExprName()

Method Summary

Modifier and Type	Method	Description
@Nullable Class<?>[]	acceptChange(Changer.ChangeMode mode)	Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.
void	change(org.bukkit.event.Event e, @Nullable Object[] delta, Changer.ChangeMode mode)	Changes the expression's value by the given amount.
@Nullable String	convert(Object o)	Converts an object from the given to the desired type.
protected String	getPropertyName()
Class<String>	getReturnType()	Gets the return type of this expression.
boolean	init(Expression<?>[] exprs, int matchedPattern, Kleenean isDelayed, SkriptParser.ParseResult parseResult)	Called just after the constructor.

Methods inherited from class ch.njol.skript.expressions.base.SimplePropertyExpression

get, toString

Methods inherited from class ch.njol.skript.expressions.base.PropertyExpression

get, get, getAll, getAnd, getExpr, isSingle, register, setExpr, simplify

Methods inherited from class ch.njol.skript.lang.util.SimpleExpression

check, check, check, getArray, getConvertedExpr, getConvertedExpression, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, setTime, setTime, setTime, setTime, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface ch.njol.skript.lang.Expression

beforeChange, stream

Methods inherited from interface ch.njol.skript.lang.SyntaxElement

getParser

Constructor Details

ExprName

public ExprName()

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.

Specified by:

init in interface SyntaxElement

Overrides:

init in class SimplePropertyExpression<Object,String>

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

convert

public @Nullable String convert(Object o)

Description copied from interface: Converter

Converts an object from the given to the desired type.

Specified by:

convert in interface Converter<Object,String>

Specified by:

convert in class SimplePropertyExpression<Object,String>

Parameters:

o - The object to convert.

Returns:

the converted object

acceptChange

public @Nullable Class<?>[] acceptChange(Changer.ChangeMode mode)

Description copied from interface: Expression

Tests whether this expression supports the given mode, and if yes what type it expects the delta to be.

Use Changer.ChangerUtils.acceptsChange(Expression, ChangeMode, Class...) to test whether an expression supports changing, don't directly use this method!

Please note that if a changer is registered for this expression's returnType this method does not have to be overridden. If you override it though make sure to return super.acceptChange(mode), and to handle the appropriate ChangeMode(s) in Expression.change(Event, Object[], ChangeMode) with super.change(...).

Unlike Changer.acceptChange(ChangeMode) this method may print errors.

Specified by:

acceptChange in interface Expression<String>

Overrides:

acceptChange in class SimpleExpression<String>

Returns:

An array of types that Expression.change(Event, Object[], ChangeMode) accepts as its delta parameter (which can be arrays to denote that multiple of that type are accepted), or null if the given mode is not supported. For Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET this can return any non-null array to mark them as supported.

change

public void change(org.bukkit.event.Event e,
 @Nullable Object[] delta,
 Changer.ChangeMode mode)

Description copied from interface: Expression

Changes the expression's value by the given amount. This will only be called on supported modes and with the desired delta type as returned by Expression.acceptChange(ChangeMode)

Specified by:

change in interface Expression<String>

Overrides:

change in class SimpleExpression<String>

delta - An array with one or more instances of one or more of the the classes returned by Expression.acceptChange(ChangeMode) for the given change mode (null for Changer.ChangeMode.DELETE and Changer.ChangeMode.RESET). This can be a Object[], thus casting is not allowed.

getReturnType

public Class<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)

getPropertyName

protected String getPropertyName()

Specified by:

getPropertyName in class SimplePropertyExpression<Object,String>