js:MapTool.tokens

 This article describes a feature or macro function that is experimental and may be subject to change.

MapTool.tokens.getSelectedTokens() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Returns a javascript array containing the selected tokens.

Usage

let a = MapTool.tokens.getSelectedTokens();

Parameters

• return - An array containing all selected tokens.

MapTool.tokens.getSelected() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Like getSelectedTokens(), but only returns the first token.

Usage

let token = MapTool.tokens.getSelected();

Parameters

• return - The first selected token, or null if no token is selected.

MapTool.tokens.getTokenByID() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

Returns the token specified if it exists on any map.

Usage

let token = MapTool.tokens.getTokenByID(tid);

Parameters

• tid - String containing a valid token ID.
• return - The token with specified ID.
• throws - ArrayIndexOutOfBounds exception if the token cannot be found.

MapTool.tokens.getMapTokenByID() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.14.0

Returns the token specified if it exists on the current map.

Usage

let token = MapTool.tokens.getTokenByID(tid);

Parameters

• tid - String containing a valid token ID.
• return - The token with specified ID.
• throws - ArrayIndexOutOfBounds exception if the token cannot be found.

MapTool.tokens.getMapTokens() Function

 Note: This function can only be used in a Trusted Macro

• Introduced in version 1.10.0

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

let token = MapTool.tokens.getMapTokens();
let token = MapTool.tokens.getMapTokens(name);

Parameters

• name - A string containing the name of the map to search for tokens.
• return - A list containing all tokens on every map.

See Also

JS: MapTool.chat
JS: MapTool.clientInfo
JS: MapTool.tokens
JS: Tokens
JS: MTScript

js.eval()