bar.name: Difference between revisions
(Edited cute but useless title override and replaced it to help clarity. Sorry. :() |
(Clarify use of bar.name) |
||
| Line 11: | Line 11: | ||
</source> | </source> | ||
Sets the value of the token bar named ''bar_name'' to the desired value. ''bar_name'' is set when the bar is created, and may be any name, provided it contains no spaces or special characters except the underscore. ''Value'' must be a number between 0 and 1. | Sets the value of the token bar named ''bar_name'' to the desired value. ''bar_name'' is set when the bar is created, and may be any name, provided it contains no spaces or special characters except the underscore. ''Value'' must be a number between 0 and 1. When providing a decimal value, include the leading 0 (e.g. enter <code>0.5</code> rather than <code>.5</code>) or your macro will produce an error. | ||
Using bar.<i>name</i> to a value will show the bar. If you try to check or use the value of bar.<i>name</i> when the bar is not already visible, your macro will produce an error. | |||
While this special variable can be convenient, Using [[:Category:Bar_Function|Token Bar Functions]] instead of token.<i>name</i> can give you more flexibility in your macros. | |||
==Examples== | ==Examples== | ||
Revision as of 03:30, 5 November 2019
The bar.[bar_name] variable permits the getting and setting of the token bar value (and the corresponding image displayed on the token) programmatically. Token bars are one, two, or multi-image graphical elements displayed on a token that are used (typically) to visually indicate the status of consumable or expendable items or character traits (such as Hit Points, Ammunition, Health, or the like).
Bars, like token states, are configured via the Campaign Properties dialog and are specific to the campaign in which they exist. In the screenshot shown below, the green-on-black line across the top of the token is a token bar.
Usage
[bar.[bar_name] = value]Sets the value of the token bar named bar_name to the desired value. bar_name is set when the bar is created, and may be any name, provided it contains no spaces or special characters except the underscore. Value must be a number between 0 and 1. When providing a decimal value, include the leading 0 (e.g. enter 0.5 rather than .5) or your macro will produce an error.
Using bar.name to a value will show the bar. If you try to check or use the value of bar.name when the bar is not already visible, your macro will produce an error.
While this special variable can be convenient, Using Token Bar Functions instead of token.name can give you more flexibility in your macros.
Examples
[h: HP = HP - DamageTaken]
[h: bar.Health = HP / MaxHP]Sets the value of bar.Health to the result of HP / MaxHP.
Notes
Two functions, setBar() and getBar() also exist to get and set the value of the token bar.