addAllNPCsToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (provided link for NP Tokens)
m (Replace deprecated <source> tag with <syntaxhighlight>)
Line 8: Line 8:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
addAllNPCsToInitiative()
addAllNPCsToInitiative()
</source>
</syntaxhighlight>


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: noTokens = addAllNPCsToInitiative()]
[h: noTokens = addAllNPCsToInitiative()]
</source>
</syntaxhighlight>




<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.
</source>
</syntaxhighlight>


|also=
|also=

Revision as of 16:23, 26 June 2021

Function addAllNPCsToInitiative() Function

 Note: This function can only be used in a Trusted Macro

Adds all the 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 the setInitiative() function

to set the initiative value of tokens.

Usage

addAllNPCsToInitiative()

Example

[h: noTokens = addAllNPCsToInitiative()]


Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.

See Also