removeFromInitiative: Difference between revisions
Jump to navigation
Jump to search
m (Conversion script moved page RemoveFromInitiative to removeFromInitiative: Converting page titles to lowercase) |
No edit summary |
||
| (3 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
|name=removeFromInitiative | |name=removeFromInitiative | ||
|description= | |description= | ||
Removes the [[Current Token]] from the [[Initiative | Removes the [[Current Token]] from the [[Introduction to Initiative|Initiative Panel]]. Additional parameters allow you to specify the token. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
removeFromInitiative() | removeFromInitiative() | ||
removeFromInitiative(id) | removeFromInitiative(id) | ||
removeFromInitiative(id, mapname) | removeFromInitiative(id, mapname) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
| Line 17: | Line 17: | ||
|example= | |example= | ||
To remove the token with the name "Dragon" in current map from the [[Initiative | To remove the token with the name "Dragon" in current map from the [[Introduction to Initiative|initiative panel]]. | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: removeFromInitiative("Dragon")] | [h: removeFromInitiative("Dragon")] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest 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 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.