setInitiative

From RPTools Wiki
Jump to navigationJump to search

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

setInitiative() Function

Introduced in version 1.3b41
Sets the Initiative of the Current Token.

Usage

setInitiative(value)
setInitiative(value, id)
setInitiative(value, id, mapname)
  • value - The initiative value to set. If included, the initiative will be set even if the token is already on the initiative list.
  • id - The token id of the token to have its initiative set. Defaults to the Current Token.

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

  • mapname - The name of the map to find the token. Defaults to the current map.

Examples

[h: setInitiative(1d20)]

Version Changes

  • 1.5.7 - Added id and mapname parameter options.