js:MapTool.clientInfo

From RPTools Wiki
Jump to navigationJump to search

 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, MapTool.clientInfo gives information about the client and user settings.


clientInfo.faceEdge() Function

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

Introduced in version 1.10.0
Returns true if tokens face the edge.

Usage

1 MapTool.clientInfo.faceEdge();

Parameters

  • return true if tokens face the edge, false otherwise.


clientInfo.faceVertex() Function

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

Introduced in version 1.10.0
Opposite of faceEdge

Usage

1 MapTool.clientInfo.faceVertex();

Parameters

  • return true if tokens face the vertex, false otherwise.


clientInfo.portraitSize() Function

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

Introduced in version 1.10.0
Returns the number of pixels used to display portraits

Usage

1 MapTool.clientInfo.portraitSize();

Parameters

  • return Number of pixels high and wide a portrait is.


clientInfo.showStatSheet() Function

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

Introduced in version 1.10.0
Returns true if the player has show stat sheet selected in preferences.

Usage

1 MapTool.clientInfo.showStatSheet();

Parameters

  • return true if the stat sheet is show.



clientInfo.version() Function

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

Introduced in version 1.10.0
Version string of maptool.

Usage

1 MapTool.clientInfo.version();

Parameters

  • return The version information of MapTool, as a string.


clientInfo.fullScreen() Function

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

Introduced in version 1.10.0
Returns if the current frame is fullscreen.

Usage

1 MapTool.clientInfo.fullScreen();

Parameters

  • return true if the current frame is fullscreen.


clientInfo.timeInMs() Function

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

Introduced in version 1.10.0
Returns the current time with ms precision.

Usage

1 MapTool.clientInfo.timeInMs();

Parameters

  • return System time in miliseconds as an integer.


clientInfo.timeDate() Function

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

Introduced in version 1.10.0
Returns the current time and date as an opaque object. Just use new Date() instead.

Usage

1 MapTool.clientInfo.timeDate();

Parameters

  • return System time as a java Date object. It can be converted to an integer or a string, but is otherwise opaque.


clientInfo.libraryTokens() Function

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

Introduced in version 1.10.0
Returns a map of all library tokens.

Usage

1 MapTool.clientInfo.libraryTokens();

Parameters

  • return Javascript object mapping library token names to library versions.


clientInfo.userDefinedFunctions() Function

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

Introduced in version 1.10.0
Returns a list of user defined function aliases.

Usage

1 MapTool.clientInfo.userDefinedFunctions();

Parameters

  • return A list of user defined function aliases.


clientInfo.getClientId() Function

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

Introduced in version 1.10.0
Returns the unique ID of the current client as a string.

Usage

1 MapTool.clientInfo.clientId();

Parameters

  • return Current client ID.


See Also

JS: MapTool