addAllNPCsToInitiative: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Cleaned up links and "See Also", removed hard return to prevent paragraph break) |
||
| (15 intermediate revisions by 7 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{Languages|addAllNPCsToInitiative}} | ||
{{MacroFunction | |||
Adds all | |name=addAllNPCsToInitiative | ||
|proposed=false | |||
|trusted=true | |||
|description=Adds all [[Introduction_to_Tokens#Token_Type|NPC tokens]] on 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. | |||
=== | 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= | ||
</ | <syntaxhighlight lang="mtmacro" line> | ||
addAllNPCsToInitiative() | |||
</syntaxhighlight> | |||
|example= | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: numTokens = addAllNPCsToInitiative()] | |||
</syntaxhighlight> | |||
<syntaxhighlight lang="mtmacro" line> | |||
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel. | |||
</syntaxhighlight> | |||
|also= | |||
{{func|setInitiative}}, {{func|addAllPCsToInitiative}}, {{func|addAllToInitiative}} | |||
}} | |||
[[Category:Initiative Function]] | |||
{{Languages|addAllNPCsToInitiative}} | |||
Latest revision as of 05:38, 6 June 2023
addAllNPCsToInitiative() Function
Note: This function can only be used in a Trusted Macro
Adds all NPC tokens on the current map to the initiative panel. This function returns the number of tokens that were added to the initiative panel.
This function will not assign any initiative value to the tokens. You can use setInitiative() to set the initiative value of a token.
Usage
addAllNPCsToInitiative()Example
[h: numTokens = addAllNPCsToInitiative()]Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.