addAllToInitiative: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (10 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{Languages|addAllToInitiative}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=addAllToInitiative | |name=addAllToInitiative | ||
|trusted=true | |trusted=true | ||
|description=Adds all of the [[Token:token|token]]s on the current [[ | |description=Adds all of the [[Token:token|token]]s on the Token Layer of the current [[Introduction to Mapping|map]] to the [[Introduction to Initiative|initiative panel]]. This function returns the number of [[Token:token|token]]s that were added to the [[Introduction to Initiative|initiative panel]]. Tokens already on the initiative panel are not counted. | ||
This function will not assign any initiative value to the [[Token:token|token]]s, you can use the [[setInitiative | setInitiative()]] function to set the initiative value of tokens. | This function will not assign any initiative value to the [[Token:token|token]]s, you can use the [[setInitiative | {{code|setInitiative()}}]] | ||
function to set the initiative value of tokens. | |||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: noTokens = addAllToInitiative()] | [h: noTokens = addAllToInitiative()] | ||
</ | </syntaxhighlight> | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
| Line 22: | Line 24: | ||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
{{Languages|addAllToInitiative}} | |||
Latest revision as of 21:34, 11 May 2024
addAllToInitiative() Function
Note: This function can only be used in a Trusted Macro
Adds all of the tokens on the Token Layer of the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel. Tokens already on the initiative panel are not counted.
This function will not assign any initiative value to the tokens, you can use the setInitiative()
Usage
[h: noTokens = addAllToInitiative()]
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.