removeFromInitiative
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 tokenid
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
andmapname
parameter options.