removeFromInitiative

From RPTools Wiki
Revision as of 23:10, 4 May 2023 by Taustin (talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

addToInitiative() removeAllFromInitiative() removeAllNPCsFromInitiative() removeAllPCsFromInitiative()

Version Changes

  • 1.5.7 - Added id and mapname parameter options.
Retrieved from "https://rptools.hyperbooks.com/index.php?title=removeFromInitiative&oldid=16978"