addAllToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(15 intermediate revisions by 5 users not shown)
Line 1: Line 1:
==Function addAllToInitiative==
{{Languages|addAllToInitiative}}
{{GMOnlyFunction}}
{{MacroFunction
Adds all of the [[Token:token|token]]s on the current map to the [[Initiative:initiative panel|initiative panel]]. This function returns the number of [[Token:token|token]]s that were added to the [[Initiative:initiative panel|initiative panel]].
|name=addAllToInitiative
|trusted=true
|description=Adds all of the [[Token:token|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.


===Usage===
This function will not assign any initiative value to the [[Token:token|token]]s, you can use the [[setInitiative | {{code|setInitiative()}}]]
<source lang="mtmacro" line>
function to set the initiative value of tokens.
 
|usage=
<syntaxhighlight lang="mtmacro" line>
[h: noTokens = addAllToInitiative()]
[h: noTokens = addAllToInitiative()]
</source>
</syntaxhighlight>
 
 
 
<syntaxhighlight lang="mtmacro" line>
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.
</syntaxhighlight>
 
|also=
[[setInitiative | setInitiative()]] [[addAllPCsToInitiative | addAllPCsToInitiative()]] [[addAllNPCsToInitiative | addAllNPCsToInitiative()]]
 
}}
[[Category:Initiative Function]]
{{Languages|addAllToInitiative}}

Latest revision as of 21:34, 11 May 2024

Languages:  English  • 日本語


addAllToInitiative() Function

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

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

function to set the initiative value of tokens.

Usage

[h: noTokens = addAllToInitiative()]


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


See Also

Languages:  English  • 日本語