addToInitiative: Difference between revisions
Jump to navigation
Jump to search
Lmarkus001 (talk | contribs) No edit summary |
Lmarkus001 (talk | contribs) No edit summary |
||
| Line 12: | Line 12: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
* {{code|AllowDuplicates}} - If false (default) then will not add the token if it is already in the initiative list.. | * {{code|AllowDuplicates}} - If false (default) then will not add the token if it is already in the initiative list. If true (1) an additional entry will be added to the initiative list (so there could be multiple initiative entries for the same token). | ||
* {{code|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. | * {{code|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. | ||
* {{code|return}} - Returns 1 if added to the initiative, 0 if did not. | * {{code|return}} - Returns 1 if added to the initiative, 0 if did not. | ||
Revision as of 18:45, 27 October 2009
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. If true (1) an additional entry will be added to the initiative list (so there could be multiple initiative entries for the same token).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()]