addAllNPCsToInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
No edit summary
Line 2: Line 2:
|name=Function addAllNPCsToInitiative
|name=Function addAllNPCsToInitiative
|trusted=true
|trusted=true
|description=Adds all the [[Token:NPC token|NPC 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 the [[Token:NPC token|NPC 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=
<source lang="mtmacro" line>
addAllNPCsToInitiative()
</source>
|example=
<source lang="mtmacro" line>
<source lang="mtmacro" line>
[h: noTokens = addAllNPCsToInitiative()]
[h: noTokens = addAllNPCsToInitiative()]
</source>
</source>
<source lang="mtmacro" line>
Added [r: addAllNPCsToInitiative()] NPCs to the initiative panel.
</source>
}}
}}
[[Category:Initiative Function]]
[[Category:Initiative Function]]

Revision as of 08:57, 25 March 2009

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.