addAllNPCsToInitiative: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (14 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
{{Languages|addAllNPCsToInitiative}} | |||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=addAllNPCsToInitiative | ||
|proposed=false | |||
|trusted=true | |trusted=true | ||
|description=Adds all | |description=Adds all [[Introduction_to_Tokens#Token_Type|NPC tokens]] 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|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 | |||
to set the initiative value of | This function will not assign any initiative value to the tokens. You can use {{func|setInitiative}} to set the initiative value of a token. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
addAllNPCsToInitiative() | addAllNPCsToInitiative() | ||
</ | </syntaxhighlight> | ||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: | [h: numTokens = addAllNPCsToInitiative()] | ||
</ | </syntaxhighlight> | ||
<syntaxhighlight lang="mtmacro" line> | |||
< | |||
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
{{func|setInitiative}}, {{func|addAllPCsToInitiative}}, {{func|addAllToInitiative}} | |||
}} | }} | ||
[[Category:Initiative Function]] | [[Category:Initiative Function]] | ||
{{Languages|addAllNPCsToInitiative}} | |||
Latest revision as of 23:59, 11 May 2024
addAllNPCsToInitiative() Function
Note: This function can only be used in a Trusted Macro
Adds all NPC 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.
Usage
addAllNPCsToInitiative()Example
[h: numTokens = addAllNPCsToInitiative()]Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.