getSize: Difference between revisions
Jump to navigation
Jump to search
m (Text replacement - "source>" to "syntaxhighlight>") |
No edit summary |
||
| (9 intermediate revisions by the same user not shown) | |||
| Line 6: | Line 6: | ||
Returns the [[Size]] of a [[Token]]. | Returns the [[Size]] of a [[Token]]. | ||
The sizes returned are: | The sizes returned on the Token Layer are: | ||
* {{code|Fine}} | * {{code|Fine}} | ||
* {{code|Diminutive}} | * {{code|Diminutive}} | ||
| Line 16: | Line 16: | ||
* {{code|Gargantuan}} | * {{code|Gargantuan}} | ||
* {{code|Colossal}} | * {{code|Colossal}} | ||
| |||
The sizes returned on the Hidden, Object and Background Layers are: | |||
* {{code|1/6}} | |||
* {{code|1/4}} | |||
* {{code|1/3}} | |||
* {{code|1/2}} | |||
* {{code|2/3}} | |||
* {{code|Medium}} | |||
* {{code|Large}} | |||
* {{code|Huge}} | |||
* {{code|Homongous}} | |||
| | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
getSize() | getSize() | ||
getSize(id) | getSize(id) | ||
| Line 31: | Line 43: | ||
|also= | |also= | ||
[[setSize|setSize()]] | [[setSize|setSize()]] [[resetSize|resetSize()]] | ||
|changes= | |changes= | ||
Latest revision as of 13:44, 8 April 2024
This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
This article needs: Examples of usage.
getSize() Function
• Introduced in version 1.3b48
Returns the Size of a Token.
The sizes returned on the Token Layer are:
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
The sizes returned on the Hidden, Object and Background Layers are:
1/61/41/31/22/3MediumLargeHugeHomongous
Usage
getSize()
getSize(id)
getSize(id, mapname)Parameter
id- The tokenidof the token which has its Size returned, 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.
- Note that if the token is in native or free size, the value returned will be an empty string: ""
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.