js:Token: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(Created page with "Within the javascript environment used by {{code|js.eval}}, Tokens are represented by the {{code|Token}} class. The token class cannot be directly instantiated, but tokens ca...")
 
m (Changed HTNL to HTML)
 
(10 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Within the javascript environment used by {{code|js.eval}}, Tokens are represented by the {{code|Token}} class.  The token class cannot be directly instantiated, but tokens can be found from the {{code|MapTool}} top level name.
{{Experimental}}
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
|name=token.getNotes
|name=token.getNotes
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the notes field of the token.
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=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.getNotes();
token.getNotes();
</source>
</syntaxhighlight>
}}
}}


Line 16: Line 17:
|name=token.setNotes
|name=token.setNotes
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Sets the notes field of the token.
Sets the Notes field of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.setNotes(newNotes);
token.setNotes(newNotes);
</source>
</syntaxhighlight>
 
* {{param|newNotes|a string representing the new Notes of the token.  See {{func|getNotes}} for details.}}
}}
}}


Line 28: Line 31:
|name=token.getName
|name=token.getName
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the name of the token.
Returns the name of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.getName();
token.getName();
</source>
</syntaxhighlight>
}}
}}


Line 40: Line 43:
|name=token.setName
|name=token.setName
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Sets the name of the token
Sets the name of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.setName(newName);
token.setName(newName);
</source>
</syntaxhighlight>
 
* {{param|newName|a string representing the new name of the token.  See {{func|setName}} for details.}}
}}
}}


Line 52: Line 57:
|name=token.hasSight
|name=token.hasSight
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns true if sight is enabled for the token
Returns {{code|true}} if sight is enabled for the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.hasSight();
token.hasSight();
</source>
</syntaxhighlight>
}}
}}


Line 64: Line 69:
|name=token.getId
|name=token.getId
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the maptool ID of the token.
Returns the MapTool token ID of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight  lang="javascript" line>
token.getId();
token.getId();
</source>
</syntaxhighlight>
}}
}}


Line 76: Line 81:
|name=token.getProperty
|name=token.getProperty
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the value of the token property.
Returns the value of the given token property.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight  lang="javascript" line>
token.getProperty(property);
token.getProperty(property);
</source>
</syntaxhighlight>
 
* {{param|property|a string representing the name of the property on the token.  See {{func|getProperty}} for details.}}
}}
}}


Line 88: Line 95:
|name=token.setProperty
|name=token.setProperty
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Sets the value of the token property.
Sets the value of the token property.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight  lang="javascript" line>
token.setProperty(property, newValue);
token.setProperty(property, newValue);
</source>
</syntaxhighlight>
 
* {{param|property|a string representing the name of the property on the token.  See {{func|setProperty}} for details.}}
* {{param|newValue|the new value to store into the token property.}}
}}
}}


Line 100: Line 110:
|name=token.getX
|name=token.getX
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the X position of the token.
Returns the X position of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight  lang="javascript" line>
token.getX();
token.getX();
</source>
</syntaxhighlight>
 
See {{func|getTokenX}} for details.
}}
}}


{{MacroFunction
{{MacroFunction
|name=token.getY
|name=token.getY
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Returns the Y position of the token.
Returns the Y position of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.getY();
token.getY();
</source>
</syntaxhighlight>
 
See {{func|getTokenY}} for details.
}}
}}


Line 125: Line 138:
|name=token.setX
|name=token.setX
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Sets the X position of the token.
Sets the X position of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight lang="javascript" line>
token.setX(newX);
token.setX(newX);
</source>
</syntaxhighlight>
 
* {{param|newX|a number representing the new X coordinate of the token.  See {{func|getTokenX}} and {{func|moveToken}} for details.}}
}}
}}


Line 137: Line 152:
|name=token.setY
|name=token.setY
|trusted=true
|trusted=true
|version=1.9.4
|version=1.10.0
|description=
|description=
Sets the Y position of the token.
Sets the Y position of the token.
|usage=
|usage=
<source lang="javascript" line>
<syntaxhighlight  lang="javascript" line>
token.setY(newY);
token.setY(newY);
</source>
</syntaxhighlight>
 
* {{param|newY|a number representing the new Y coordinate of the token.  See {{func|getTokenY}} and {{func|moveToken}} for details.}}
}}
 
{{MacroFunction
|name=token.isOwner
|trusted=true
|version=1.10.0
|description=
Returns {{code|true}} if the given player is an owner.
|usage=
<syntaxhighlight  lang="javascript" line>
token.isOwner(playerName);
</syntaxhighlight>
 
* {{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:
* 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}}.
}}
 
{{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>
}}
}}


<h3>See Also</h3>
<h2>See Also</h2>


[[js:MapTool|JS: MapTool]]<br/>
[[js:MapTool|JS: MapTool]]<br/>
[[Category:Javascript Function]]
[[Category:Javascript Function]]

Latest revision as of 02:54, 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);


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


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();


See Also

JS: MapTool

Retrieved from "https://wiki.rptools.info/index.php?title=js:Token&oldid=17584"