addAllPCsToInitiative: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
| (19 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{Languages|addAllPCsToInitiative}} | |||
{{ | {{MacroFunction | ||
Adds all the [[PC token]]s on the current map to the [[initiative panel]]. This function returns the number of | |name=addAllPCsToInitiative | ||
|trusted=true | |||
|description=Adds all the [[Introduction_to_Tokens#Token_Type|PC 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 | {{code|setInitiative()}}]] | |||
< | function to set the initiative value of tokens. | ||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: noTokens = addAllPCsToInitiative()] | [h: noTokens = addAllPCsToInitiative()] | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | |||
</syntaxhighlight> | |||
|also= | |||
[[setInitiative | setInitiative()]] [[addAllNPCsToInitiative | addAllNPCsToInitiative()]] [[addAllToInitiative | addAllToInitiative()]] | |||
}} | |||
[[Category:Initiative Function]] | |||
{{Languages|addAllPCsToInitiative}} | |||
Latest revision as of 23:59, 11 May 2024
addAllPCsToInitiative() Function
Note: This function can only be used in a Trusted Macro
Adds all the PC 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 = addAllPCsToInitiative()]
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.