removeFromInitiative: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function removeFromInitiative== Removes the Token:Current Token from the Initiative:Initiative Panel. ===Usage=== <source lang="mtmacro" line> [h: removeFromInitiative(n...) |
No edit summary |
||
(9 intermediate revisions by 4 users not shown) | |||
Line 1: | Line 1: | ||
== | {{MacroFunction | ||
|name=removeFromInitiative | |||
|description= | |||
Removes the [[Current Token]] from the [[Introduction to Initiative|Initiative Panel]]. Additional parameters allow you to specify the token. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
removeFromInitiative() | |||
removeFromInitiative(id) | |||
removeFromInitiative(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|id|The token {{code|id}} of the token to be removed from the initiative. Defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
* {{code|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 [[Introduction to Initiative|initiative panel]]. | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: removeFromInitiative("Dragon")] | |||
</syntaxhighlight> | |||
|also= | |||
[[addToInitiative | addToInitiative()]] [[removeAllFromInitiative | removeAllFromInitiative()]] [[removeAllNPCsFromInitiative | removeAllNPCsFromInitiative()]] [[removeAllPCsFromInitiative | removeAllPCsFromInitiative()]] | |||
|changes= | |||
{{change|1.5.7|Added {{code|id}} and {{code|mapname}} parameter options.}} | |||
}} | |||
[[Category:Initiative Function]] | |||
[ | |||
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 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.