getSize: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:getSize moved to getSize) |
No edit summary |
||
(20 intermediate revisions by 7 users not shown) | |||
Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=getSize | |name=getSize | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns the [[ | Returns the [[Size]] of a [[Token]]. | ||
The sizes returned are | |||
* Diminutive | The sizes returned on the Token Layer are: | ||
* Tiny | * {{code|Fine}} | ||
* Small | * {{code|Diminutive}} | ||
* Medium | * {{code|Tiny}} | ||
* Large | * {{code|Small}} | ||
* Huge | * {{code|Medium}} | ||
* | * {{code|Large}} | ||
* | * {{code|Huge}} | ||
* | * {{code|Gargantuan}} | ||
* {{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(id) | |||
getSize(id, mapname) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{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: "" | |||
|also= | |||
[[setSize|setSize()]] [[resetSize|resetSize()]] | |||
|changes= | |||
{{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 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:
Fine
Diminutive
Tiny
Small
Medium
Large
Huge
Gargantuan
Colossal
The sizes returned on the Hidden, Object and Background Layers are:
1/6
1/4
1/3
1/2
2/3
Medium
Large
Huge
Homongous
Usage
getSize()
getSize(id)
getSize(id, mapname)
Parameter
id
- The tokenid
of 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
id
parameter option. - 1.5.4 - Added
mapname
parameter option.