setSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
m (Document "Free" and "Native" size options.) |
||
Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the size of a [[Token]] with one of the defined sizes according to each Grid Type. | Sets the size of a [[Token]] with one of the defined sizes according to each Grid Type. The sizes can be found on the [[Token Size]] page. "Free" or "Native" are also valid values. | ||
|usage= | |usage= | ||
Line 13: | Line 13: | ||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|size| | {{param|size|A [[Token Size]] to set the token to. Can be "Free" or "Native" as well.}} | ||
{{param|id|The token {{code|id}} of the token which will have its [[ | {{param|id|The token {{code|id}} of the token which will have its [[Token Size]] set. Defaults to the [[Current Token]].}} | ||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | {{param|mapname|The name of the map to find the token. Defaults to the current map.}} | ||
Revision as of 08:36, 27 June 2021
setSize() Function
Note: This function can only be used in a Trusted Macro
• Introduced in version 1.3b48
Sets the size of a Token with one of the defined sizes according to each Grid Type. The sizes can be found on the Token Size page. "Free" or "Native" are also valid values.
Usage
setSize(size)
setSize(size, id)
setSize(size, id, mapname)
Parameters
size
- A Token Size to set the token to. Can be "Free" or "Native" as well.id
- The tokenid
of the token which will have its Token Size set. Defaults to the Current Token.mapname
- The name of the map to find the token. Defaults to the current map.
Examples
To set the size of the current token to
Medium
:
[h: setSize("Medium")]
To set the size of the current token to whatever string is stored in the macro variable mySize:
[h: mySize = "Large"]
[h: setSize(mySize)]
See Also
Version Changes
- 1.3b51 - Added
id
parameter option. - 1.5.4 - Added
mapname
parameter option.