nextInitiative: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Replaced source tages with syntaxhighlight)
(7 intermediate revisions by 3 users not shown)
Line 1: Line 1:
==Function nextInitiative==
{{MacroFunction
 
    |name=nextInitiative
Advances the initiative to the next [[Token:token|Token]] in the [[Initiative:Initiative Panel|Initiative Panel]]. Only the [[GM]] or a trusted macro can call this function. This function returns the offset into the [[Initiative:Initiative Panel|Initiative Panel]] (starting at 0) of the [[Token:Token|Token]] that will get the [[Initiative:Initiative|Initiative]].
    |trusted=true
    |version=1.3b41
    |description=
    Advances the initiative to the next [[Introduction to Tokens|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 [[Introduction to Tokens|Token]] that will get the Initiative.
    * ''Since 1.8'': This function triggers the {{code|[[onInitiativeChangeRequest]]}} (and {{code|[[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===
    |usage=
<source lang="mtmacro" line>
    <syntaxhighlight lang="mtmacro" line>
[h: nextInitiative()]
    nextInitiative()
</source>
    </syntaxhighlight>
    |also=
    {{func|prevInitiative}}
    |changes=
    * '''1.8''' - function now triggers the new {{code|onInitiativeChangeRequest}} and {{code|onInitiativeChange}} events
    * '''1.3b41''' - Added function
    }}
    [[Category:Initiative Function]]

Revision as of 18:04, 14 July 2022

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. * Since 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