setBar: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
(Add 'See Also' and 'Related Pages' to bar functions.)
No edit summary
(One intermediate revision by one other user not shown)
Line 1: Line 1:
{{stub}}
{{MacroFunction
{{MacroFunction
|name=setBar
|name=setBar
Line 5: Line 4:
|version=1.3b42
|version=1.3b42
|description=
|description=
Sets the value of the specified [[Token:bar|bar]] for the [[Current Token]]. The value to set is between 0 and 1 for 0% to 100% respectively.
Sets the value of the specified [[Token:bar|bar]] for the [[Current Token]] and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.


|usage=
|usage=

Revision as of 14:25, 5 November 2019

setBar() Function

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

Introduced in version 1.3b42
Sets the value of the specified bar for the Current Token and makes the bar visible. The value to set is between 0 and 1 for 0% to 100% respectively.

Usage

setBar(name, pct/100)
setBar(name, pct/100, id)
setBar(name, pct/100, id, mapname)

Parameters

  • name - The name of the bar.
  • value - The value of the bar. Should be between 0 and 1.
  • id - The token id of the token which has its bar 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.

Example

[h: setBar("Health", HP/MaxHP)]

See Also

Version Changes

  • 1.5.7 - Added id and mapname parameter options.

Related Pages