setSize: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
No edit summary |
||
| (23 intermediate revisions by 11 users not shown) | |||
| Line 1: | Line 1: | ||
{{MacroFunction | {{MacroFunction | ||
|name= | |name=setSize | ||
|trusted=true | |trusted=true | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the [[ | Sets the size of a [[Token]] with one of the defined sizes according to each Grid Type. {{Note|The names of each size are based on the type of grid the map uses. The sizes can be found on the [[Token Size]] page.}} "Free" or "Native" are also valid values. | ||
The | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | |||
setSize(size) | |||
setSize(size, id) | |||
setSize(size, id, mapRef) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{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 [[Token Size]] set. Defaults to the [[Current Token]].}} | |||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
The sizes available on the for Square grid maps are: | |||
* {{code|Fine}} | |||
* {{code|Diminutive}} | * {{code|Diminutive}} | ||
* {{code|Tiny}} | * {{code|Tiny}} | ||
| Line 14: | Line 25: | ||
* {{code|Large}} | * {{code|Large}} | ||
* {{code|Huge}} | * {{code|Huge}} | ||
* {{code|Gargantuan}} | * {{code|Gargantuan}} | ||
* {{code|Colossal}} | * {{code|Colossal}} | ||
| |||
|examples= | |||
To set the size of the current token to {{code|Medium}}: | |||
<syntaxhighlight lang="mtmacro" line> | |||
[h: setSize("Medium")] | |||
</syntaxhighlight> | |||
To set the size of the current token to whatever string is stored in the macro variable '''mySize''': | |||
< | <syntaxhighlight lang="mtmacro" line> | ||
[h: mySize = "Large"] | |||
[h: setSize(mySize)] | |||
</syntaxhighlight> | |||
setSize( | |||
</ | |||
|also= | |also= | ||
[[ | {{func|getSize}} [[resetSize|resetSize()]] | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 23:59, 16 April 2024
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 names of each size are based on the type of grid the map uses. 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, mapRef)Parameters
size- A Token Size to set the token to. Can be "Free" or "Native" as well.id- The tokenidof the token which will have its Token Size set. Defaults to the Current Token.mapRef- The Name or ID of the map to find the token. Defaults to the current map.
The sizes available on the for Square grid maps are:
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
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
idparameter option. - 1.5.4 - Added
mapnameparameter option.