js:Token: Difference between revisions
Jump to navigation
Jump to search
m (Added missing parameter to isOwner()) |
m (Changed HTNL to HTML) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Experimental}} | {{Experimental}} | ||
Within the | Within the JavaScript environment used by {{code|js.eval}}, ie. the one that executes within GraalVM and NOT the one used by {{func|dialog5}} or {{func|frame5}}, tokens are represented by the {{code|Token}} class. The {{code|Token}} class cannot be directly instantiated, but tokens can be found from the {{code|MapTool}} top level name. | ||
{{MacroFunction | {{MacroFunction | ||
| Line 7: | Line 7: | ||
|version=1.10.0 | |version=1.10.0 | ||
|description= | |description= | ||
Returns the Notes field of the token. No processing of the content is performed (this means Notes entered as | Returns the Notes field of the token. No processing of the content is performed (this means Notes entered as HTML will return the HTML content, for example). | ||
|usage= | |usage= | ||
<syntaxhighlight lang="javascript" line> | <syntaxhighlight lang="javascript" line> | ||
| Line 174: | Line 174: | ||
</syntaxhighlight> | </syntaxhighlight> | ||
* {{param|playerName|a string representing the player name to check for. See {{func|isOwner}} for details, but note that this function | * {{param|playerName|a string representing the player name to check for. See {{func|isOwner}} for details, but note that this function requires a single parameter and the MTscript one does not.}} | ||
Ownership is determined thusly: | Ownership is determined thusly: | ||
* | * This call is running in a '''trusted''' context — returns {{code|true}}. | ||
* | * This token has '''ALL''' players as owners — returns {{code|true}}. | ||
* | * This token has the given player name in the list of owners — returns {{code|true}}. | ||
* All other conditions return {{code|false}}. | * All other conditions return {{code|false}}. | ||
}} | |||
{{MacroFunction | |||
|name=token.isOnCurrentMap | |||
|trusted=false | |||
|version=1.14.0 | |||
|description= | |||
Checks whether the specified token is on the current map. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.isOnCurrentMap(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.getMapName | |||
|trusted=false | |||
|version=1.14.0 | |||
|description= | |||
Returns the name of the map the token resides on. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.getMapName(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.getState | |||
|trusted=false | |||
|version=1.15.0 | |||
|description= | |||
Checks whether the specified State is active on a token, returning true or false. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.getState(stateName); | |||
</syntaxhighlight> | |||
* {{param|stateName|The name of the state to check for. See {{func|getState}} for MTScript equivalent.}} | |||
}} | |||
{{MacroFunction | |||
|name=token.setState | |||
|trusted=true | |||
|version=1.15.0 | |||
|description= | |||
Sets the value of the State on Token. If The value is false then the State is unset if it is true then it is set. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.setState(stateName, aValue); | |||
</syntaxhighlight> | |||
* {{param|stateName|The name of the state to set. See {{func|setState}} for MTScript equivalent.}} | |||
* {{param|aValue|boolean state to set.}} | |||
}} | |||
{{MacroFunction | |||
|name=token.setAllStates | |||
|trusted=true | |||
|version=1.15.0 | |||
|description= | |||
Sets the value of all States on Token. If The value is false then all States are unset if it is true then they are set. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.setAllStates(aValue); | |||
</syntaxhighlight> | |||
* {{param|aValue|boolean state to set. See {{func|setAllStates}} for MTScript equivalent.}} | |||
}} | |||
{{MacroFunction | |||
|name=token.getActiveStates | |||
|trusted=false | |||
|version=1.15.0 | |||
|description= | |||
Returns a list of states for the token that are currently set(true). | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.getActiveStates(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.isPC | |||
|trusted=false | |||
|version=1.15.0 | |||
|description= | |||
Checks whether the token is a PC token. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.isPC(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.setPC | |||
|trusted=true | |||
|version=1.15.0 | |||
|description= | |||
Sets the token to be a PC Token. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.setPC(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.isNPC | |||
|trusted=false | |||
|version=1.15.0 | |||
|description= | |||
Checks whether the token is an NPC token. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.isNPC(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.setNPC | |||
|trusted=true | |||
|version=1.15.0 | |||
|description= | |||
Sets the token to be an NPC Token. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.setNPC(); | |||
</syntaxhighlight> | |||
}} | |||
{{MacroFunction | |||
|name=token.getType | |||
|trusted=false | |||
|version=1.15.0 | |||
|description= | |||
Returns "PC" if token is a PC, and "NPC" if an NPC. | |||
|usage= | |||
<syntaxhighlight lang="javascript" line> | |||
token.getType(); | |||
</syntaxhighlight> | |||
}} | }} | ||
Latest revision as of 23:59, 10 February 2024
This article describes a feature or macro function that is experimental and may be subject to change.
Within the JavaScript environment used by js.eval, ie. the one that executes within GraalVM and NOT the one used by dialog5() or frame5(), tokens are represented by the Token class. The Token class cannot be directly instantiated, but tokens can be found from the MapTool top level name.
token.getNotes() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the Notes field of the token. No processing of the content is performed (this means Notes entered as HTML will return the HTML content, for example).
Usage
token.getNotes();
token.setNotes() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets the Notes field of the token.
Usage
token.setNotes(newNotes);
newNotes- a string representing the new Notes of the token. See getNotes() for details.
token.getName() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the name of the token.
Usage
token.getName();
token.setName() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets the name of the token.
Usage
token.setName(newName);
newName- a string representing the new name of the token. See setName() for details.
token.hasSight() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns
true if sight is enabled for the token.Usage
token.hasSight();
token.getId() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the MapTool token ID of the token.
Usage
token.getId();
token.getProperty() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the value of the given token property.
Usage
token.getProperty(property);
property- a string representing the name of the property on the token. See getProperty() for details.
token.setProperty() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets the value of the token property.
Usage
token.setProperty(property, newValue);
property- a string representing the name of the property on the token. See setProperty() for details.newValue- the new value to store into the token property.
token.getX() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the X position of the token.
Usage
token.getX();
See getTokenX() for details.
token.getY() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns the Y position of the token.
Usage
token.getY();
See getTokenY() for details.
token.setX() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets the X position of the token.
Usage
token.setX(newX);
newX- a number representing the new X coordinate of the token. See getTokenX() and moveToken() for details.
token.setY() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Sets the Y position of the token.
Usage
token.setY(newY);
newY- a number representing the new Y coordinate of the token. See getTokenY() and moveToken() for details.
token.isOwner() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.10.0
Returns
true if the given player is an owner.Usage
token.isOwner(playerName);
playerName- a string representing the player name to check for. See isOwner() for details, but note that this function requires a single parameter and the MTscript one does not.
Ownership is determined thusly:
- This call is running in a trusted context — returns
true. - This token has ALL players as owners — returns
true. - This token has the given player name in the list of owners — returns
true. - All other conditions return
false.
token.isOnCurrentMap() Function
• Introduced in version 1.14.0
Checks whether the specified token is on the current map.
Usage
token.isOnCurrentMap();
token.getMapName() Function
• Introduced in version 1.14.0
Returns the name of the map the token resides on.
Usage
token.getMapName();
token.getState() Function
• Introduced in version 1.15.0
Checks whether the specified State is active on a token, returning true or false.
Usage
token.getState(stateName);
stateName- The name of the state to check for. See getState() for MTScript equivalent.
token.setState() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.15.0
Sets the value of the State on Token. If The value is false then the State is unset if it is true then it is set.
Usage
token.setState(stateName, aValue);
stateName- The name of the state to set. See setState() for MTScript equivalent.aValue- boolean state to set.
token.setAllStates() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.15.0
Sets the value of all States on Token. If The value is false then all States are unset if it is true then they are set.
Usage
token.setAllStates(aValue);
aValue- boolean state to set. See setAllStates() for MTScript equivalent.
token.getActiveStates() Function
• Introduced in version 1.15.0
Returns a list of states for the token that are currently set(true).
Usage
token.getActiveStates();
token.isPC() Function
• Introduced in version 1.15.0
Checks whether the token is a PC token.
Usage
token.isPC();
token.setPC() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.15.0
Sets the token to be a PC Token.
Usage
token.setPC();
token.isNPC() Function
• Introduced in version 1.15.0
Checks whether the token is an NPC token.
Usage
token.isNPC();
token.setNPC() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.15.0
Sets the token to be an NPC Token.
Usage
token.setNPC();
token.getType() Function
• Introduced in version 1.15.0
Returns "PC" if token is a PC, and "NPC" if an NPC.
Usage
token.getType();