getSize: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| Line 21: | Line 21: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
getSize() | getSize() | ||
getSize(id) | getSize(id) | ||
getSize(id, mapname) | |||
</source> | </source> | ||
'''Parameter''' | '''Parameter''' | ||
{{param|id|The token {{code|id}} of the token which has its [[Size]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its [[Size]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|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: "" | * Note that if the token is in native or free size, the value returned will be an empty string: "" | ||
| Line 34: | Line 35: | ||
|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]] | ||
Revision as of 19:47, 15 August 2019
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 are:
FineDiminutiveTinySmallMediumLargeHugeGargantuanColossal
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.