removeFromInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 17: Line 17:


|example=
|example=
To remove the token with the name "Dragon" in current map from the [[introduction to Initiative|initiative panel]].
To remove the token with the name "Dragon" in current map from the [[Introduction to Initiative|initiative panel]].


<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>

Revision as of 23:10, 4 May 2023

removeFromInitiative() Function

Removes the Current Token from the Initiative Panel. Additional parameters allow you to specify the token.

Usage

removeFromInitiative()
removeFromInitiative(id)
removeFromInitiative(id, mapname)

Parameters

  • id - The token id of the token to be removed from the initiative. Defaults to the Current Token.

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

  • mapname - The name of the map to find the token. Defaults to the current map.
  • return - Returns 1 if removed from the initiative, 0 if did not.

Example

To remove the token with the name "Dragon" in current map from the initiative panel.
[h: removeFromInitiative("Dragon")]

See Also

Version Changes

  • 1.5.7 - Added id and mapname parameter options.