addAllToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Line 3: Line 3:
|trusted=true
|trusted=true
|description=Adds all of the [[Token:token|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]].
|description=Adds all of the [[Token:token|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]].
This function will not assign any initiative value to the [[Token:token|token]]s, you can use the [[setInitiative | setInitiative()]] function to set the initiative value of tokens.


|usage=
|usage=
Line 8: Line 10:
[h: noTokens = addAllToInitiative()]
[h: noTokens = addAllToInitiative()]
</source>
</source>
<source lang="mtmacro" line>
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.
</source>
|also=
[[setInitiative | setInitiative()]] [[addAllPCsToInitiative | addAllPCsToInitiative()]] [[addAllNPCsToInitiative | addAllNPCsToInitiative()]]
}}
}}
[[Category:Initiative Function]]
[[Category:Initiative Function]]

Revision as of 09:09, 25 March 2009

addAllToInitiative() Function

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

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


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


See Also