prevInitiative

prevInitiative() Function

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

• Introduced in version 1.8

Restores the initiative to the previous Token in the Initiative Panel, returning to the previous round if necessary. 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 receive Initiative. Note: neither this function nor the corresponding UI button will allow the Initiative to fall back any further than the first token in the first round.

• 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

prevInitiative()

See Also

nextInitiative()

Version Changes

• 1.8 - Added function.