Package org.skriptlang.skript.common.properties.expressions

Class PropExprName

java.lang.Object

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

org.skriptlang.skript.lang.properties.PropertyBaseExpression<PropertyHandler.ExpressionPropertyHandler<?,?>>

org.skriptlang.skript.common.properties.expressions.PropExprName

All Implemented Interfaces:

Debuggable, Expression<Object>, Loopable<Object>, Simplifiable<Expression<? extends Object>>, SyntaxElement, PropertyBaseSyntax<PropertyHandler.ExpressionPropertyHandler<?,?>>, RuntimeErrorProducer, SyntaxRuntimeErrorProducer

@Name("Name")
@Description({"Represents the Minecraft account name of a player, or the custom name of an item, entity, block, inventory, gamerule, world, script or function.","","<strong>Players:</strong> The Minecraft account name of the player. Can\'t be changed.","","<strong>Entities:</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\'.","","<strong>Items:</strong> The <em>custom</em> name of the item (not the Minecraft locale name). Can be changed.","","<strong>Inventories:</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.","","<strong>Gamerules:</strong> The name of the gamerule. Cannot be changed.","","<strong>Worlds:</strong> The name of the world. Cannot be changed.","","<strong>Scripts:</strong> The name of a script, excluding its file extension."})
@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%\"","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)","2.7 (worlds)"})
@RelatedProperty("name")
public class PropExprName
extends PropertyBaseExpression<PropertyHandler.ExpressionPropertyHandler<?,?>>

Field Summary

Fields inherited from class org.skriptlang.skript.lang.properties.PropertyBaseExpression

expr, properties, property, returnType, returnTypes, useCIP

Constructor Summary

Constructors

Constructor	Description
PropExprName()

Method Summary

Modifier and Type	Method	Description
Property<PropertyHandler.ExpressionPropertyHandler<?,?>>	getProperty()	Gets the property this expression represents.

Methods inherited from class org.skriptlang.skript.lang.properties.PropertyBaseExpression

acceptChange, change, convert, get, getPropertyReturnTypes, getReturnType, init, isSingle, possibleReturnTypes, register, toString

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

check, check, check, getAll, getAnd, getArray, getConvertedExpr, getConvertedExpression, getNode, getSingle, getSource, getTime, isDefault, isLoopOf, iterator, preInit, setTime, setTime, setTime, setTime, setTime, simplify, supportsLoopPeeking, 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, canBeSingle, canReturn, changeInPlace, changeInPlace, getAcceptedChangeModes, getOptionalSingle, getSyntaxTypeName, stream, streamAll

Methods inherited from interface org.skriptlang.skript.lang.properties.PropertyBaseSyntax

getBadTypesErrorMessage, getPropertyName

Methods inherited from interface org.skriptlang.skript.log.runtime.RuntimeErrorProducer

error, error, getRuntimeErrorManager, warning, warning

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

getParser

Methods inherited from interface org.skriptlang.skript.log.runtime.SyntaxRuntimeErrorProducer

getErrorSource

Constructor Details

PropExprName

public PropExprName()

Method Details

getProperty

public Property<PropertyHandler.ExpressionPropertyHandler<?,?>> getProperty()

Description copied from interface: PropertyBaseSyntax

Gets the property this expression represents. This is used to find the appropriate handlers for the expression's input types.

Returns:

The property this expression represents.