token.initHold: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(New page: The variable ''token.initHold'' is a binary variable that indicates whether a token in the Initiative Panel is on hold, or is part of the normal initiative ...)
 
No edit summary
(2 intermediate revisions by 2 users not shown)
Line 4: Line 4:


<source lang="mtmacro" line>
<source lang="mtmacro" line>
Token's Hold Status: [token.initHold]
[token.initHold = value]
</source>
</source>


Returns 1 if the token is currently on hold, and 0 if the token is not on hold.
Where ''value'' is either 1 or 0.


==Example==
==Example==
Line 29: Line 29:


* [[Initiative:initiative_panel|Initiative Panel]]
* [[Initiative:initiative_panel|Initiative Panel]]
* [[Macros:Special_Variables:token.init|token.init]]
* [[token.init]]
* [[Macros:Variables:list_of_special_variables|List of Special Variables]]
[[Category:Special Variable]]

Revision as of 13:53, 25 March 2009

The variable token.initHold is a binary variable that indicates whether a token in the Initiative Panel is on hold, or is part of the normal initiative cycle. token.initHold can take a value of 1 (token is on hold) or 0 (token is not on hold).

Usage

[token.initHold = value]

Where value is either 1 or 0.

Example

[h:status=input(
    "hold|Yes,No|Put token on hold in initiative order?|RADIO|SELECT=0 ORIENT=H VALUE=STRING"
    )]
[h:abort(status)]

[h:token.initHold = if(hold=="Yes", 1, 0)]

Presents the following dialog using the input() function:

and, based on the user's selection, sets token.initHold to either 1 or 0. When this macro is executed, the token's image or line in the Initiative Panel will be altered to reflect its new status.

Related Pages