View source for js:MapTool.tokens

{{Experimental}}

{{MacroFunction
|name=MapTool.tokens.getSelectedTokens
|trusted=true
|version=1.10.0
|description=
Returns a javascript array containing the selected tokens.  

|usage=
<syntaxhighlight lang="javascript" line>
let a = MapTool.tokens.getSelectedTokens();
</syntaxhighlight>

'''Parameters'''
* {{code|return}} - An array containing all selected tokens.


}}
{{MacroFunction
|name=MapTool.tokens.getSelected
|trusted=true
|version=1.10.0
|description=
Like {{code|getSelectedTokens()}}, but only returns the first token.

|usage=
<syntaxhighlight lang="javascript" line>
let token = MapTool.tokens.getSelected();
</syntaxhighlight>

'''Parameters'''
* {{code|return}} - The first selected token, or {{code|null}} if no token is selected.



}}
{{MacroFunction
|name=MapTool.tokens.getTokenByID
|trusted=true
|version=1.10.0
|description=
Returns the token specified if it exists on any map.

|usage=
<syntaxhighlight lang="javascript" line>
let token = MapTool.tokens.getTokenByID(tid);
</syntaxhighlight>

'''Parameters'''
* {{code|tid}} - String containing a valid token ID.
* {{code|return}} - The token with specified ID.  
* {{code|throws}} - ArrayIndexOutOfBounds exception if the token cannot be found.
}}

{{MacroFunction
|name=MapTool.tokens.getMapTokenByID
|trusted=true
|version=1.14.0
|description=
Returns the token specified if it exists on the current map.

|usage=
<syntaxhighlight lang="javascript" line>
let token = MapTool.tokens.getTokenByID(tid);
</syntaxhighlight>

'''Parameters'''
* {{code|tid}} - String containing a valid token ID.
* {{code|return}} - The token with specified ID.  
* {{code|throws}} - ArrayIndexOutOfBounds exception if the token cannot be found.
}}

{{MacroFunction
|name=MapTool.tokens.getMapTokens
|trusted=true
|version=1.10.0
|description=
Returns a list of all tokens on a map.  If run from an untrusted namespace, only tokens owned by the calling player are returned.

|usage=
<syntaxhighlight lang="javascript" line>
let token = MapTool.tokens.getMapTokens();
let token = MapTool.tokens.getMapTokens(name);
</syntaxhighlight>

'''Parameters'''
* {{code|name}} - A string containing the name of the map to search for tokens.
* {{code|return}} - A list containing all tokens on every map.  






}}
<h3>See Also</h3>

[[js:MapTool.chat|JS: MapTool.chat]]<br/>
[[js:MapTool.clientInfo|JS: MapTool.clientInfo]]<br/>
[[js:MapTool.tokens|JS: MapTool.tokens]]<br/>
[[js:Token|JS: Tokens]]<br/>
[[js:MTScript|JS: MTScript]]<br/>

{{func|js.eval}}
[[Category:Javascript Function]]