removeFromInitiative: Difference between revisions
Jump to navigation
Jump to search
Sharcashmo (talk | contribs) (Documentation was incomplete and didn't included any parameter. Version change date may be incorrect, I guess parameters were added in the same version than with addToInitiative() and other functions) |
m (Conversion script moved page removeFromInitiative to RemoveFromInitiative without leaving a redirect: Converting page title to first-letter uppercase) |
(No difference)
| |
Revision as of 22:19, 9 February 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 tokenidof 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
idandmapnameparameter options.