setBar: Difference between revisions
Jump to navigation
Jump to search
(Add 'See Also' and 'Related Pages' to bar functions.) |
No edit summary |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
{{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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setBar(name, pct/100) | setBar(name, pct/100) | ||
setBar(name, pct/100, | setBar(name, pct/100, tokenRef) | ||
setBar(name, pct/100, | setBar(name, pct/100, tokenRef, mapRef) | ||
</ | </syntaxhighlight> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|name|The name of the bar.}} | {{param|name|The name of the bar.}} | ||
{{param|value|The value of the bar. Should be between 0 and 1.}} | {{param|value|The value of the bar. Should be between 0 and 1.}} | ||
{{param| | {{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param| | {{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | ||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: setBar("Health", HP/MaxHP)] | [h: setBar("Health", HP/MaxHP)] | ||
</ | </syntaxhighlight> | ||
|also= | |also= | ||
Latest revision as of 23:59, 10 May 2024
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, tokenRef)
setBar(name, pct/100, tokenRef, mapRef)Parameters
name- The name of the bar.value- The value of the bar. Should be between 0 and 1.tokenRef- Either the tokenidor Token Name of the token, defaults to the Current Token.Note: This parameter can only be used in a Trusted Macro.
mapRef- The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
Example
[h: setBar("Health", HP/MaxHP)]See Also
Version Changes
- 1.5.7 - Added
idandmapnameparameter options.