nextInitiative

From RPTools Wiki
Revision as of 19:17, 7 September 2020 by Selquest (talk | contribs) (Added interaction with onInitiativeChangeRequest and onInitiativeChange events coming in 1.8)
Jump to navigation Jump to search

nextInitiative() Function

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

Introduced in version 1.3b41
Advances the initiative to the next Token in the Initiative Panel. Only the GM or a trusted macro can call this function. This function returns the offset into the Initiative Panel (starting at 0) of the Token that will get the Initiative.
  • Coming in 1.8: This function triggers the onInitiativeChangeRequest (and onInitiativeChange) events, so it is possible that the change will be blocked. See the Guide to Initiative Events for more details. This function will return the offset of the token that has initiative after this function completes, whether the change proceeded as requested or not.

Usage

nextInitiative()


See Also

Version Changes

  • 1.8 - function now triggers the new onInitiativeChangeRequest and onInitiativeChange events
  • 1.3b41 - Added function