addAllNPCsToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
m (Cleaned up links and "See Also", removed hard return to prevent paragraph break)
Line 1: Line 1:
{{Languages|addAllNPCsToInitiative}}
{{Languages|addAllNPCsToInitiative}}
{{MacroFunction
{{MacroFunction
|name=Function addAllNPCsToInitiative
|name=addAllNPCsToInitiative
|proposed=false
|trusted=true
|trusted=true
|description=Adds all the [[Introduction_to_Tokens#Token_Type|NPC token]]s on 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]].  
|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 [[Token:token|token]]s, you can use the [[setInitiative | {{code|setInitiative()}}]] function
This function will not assign any initiative value to the tokens. You can use {{func|setInitiative}} to set the initiative value of a token.
to set the initiative value of tokens.


|usage=
|usage=
Line 15: Line 15:
|example=
|example=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[h: noTokens = addAllNPCsToInitiative()]
[h: numTokens = addAllNPCsToInitiative()]
</syntaxhighlight>
</syntaxhighlight>


<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
Line 24: Line 23:


|also=
|also=
[[setInitiative | setInitiative()]] [[addAllPCsToInitiative | addAllPCsToInitiative()]] [[addAllToInitiative | addAllToInitiative()]]
{{func|setInitiative}}, {{func|addAllPCsToInitiative}}, {{func|addAllToInitiative}}
 
}}
}}
[[Category:Initiative Function]]
[[Category:Initiative Function]]
{{Languages|addAllNPCsToInitiative}}
{{Languages|addAllNPCsToInitiative}}

Revision as of 05:38, 6 June 2023

Languages:  English  • 日本語


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.

See Also

Languages:  English  • 日本語