addToInitiative

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.

addToInitiative() Function

Adds the Current Token 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: addToInitiative()]
[H: return = addToInitiative( AllowDuplicates, value ) ]

Parameters

• AllowDuplicates - If false (default) then will not add the token if it is already in the initiative list..
• value - The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list and duplicates are not allowed.
• return - Returns 1 if added to the initiative, 0 if did not.

Example

The following example shows how to add a Current Token to the initiative panel, set

its initiative and then sort the initiative panel. Normally you would not sort the initiative panel every time you add a Current Token but its done here to show you how it is done.

[h: addToInitiative()]
[h: setInitiative(1d20)]
[h: sortInitiative()]

See Also

setInitiative() addAllPCsToInitiative() addAllToInitiative()