addAllPCsToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
mNo edit summary
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
==Function addAllPCsToInitiative==
{{Languages|addAllPCsToInitiative}}
{{GMOnlyFunction}}
{{MacroFunction
Adds all the [[Token:PC token|PC token]]s on the current [[Map:map|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=addAllPCsToInitiative
|trusted=true
|description=Adds all the [[Token:PC token|PC token]]s on the current [[Map:map|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]].


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

Revision as of 06:39, 2 August 2021

Languages:  English  • 日本語


addAllPCsToInitiative() Function

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

Adds all the PC 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

[h: noTokens = addAllPCsToInitiative()]


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


See Also

Languages:  English  • 日本語