getSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
(7 intermediate revisions by the same user not shown) | |||
Line 18: | Line 18: | ||
| | ||
The sizes returned on the Object | The sizes returned on the Hidden, Object and Background Layers are: | ||
* {{code|1/6}} | * {{code|1/6}} | ||
* {{code|1/4}} | * {{code|1/4}} | ||
* {{code|1/3}} | * {{code|1/3}} | ||
* {{code|1/ | * {{code|1/2}} | ||
* {{code| | * {{code|2/3}} | ||
* {{code|Medium}} | * {{code|Medium}} | ||
* {{code|Large}} | * {{code|Large}} | ||
Line 29: | Line 29: | ||
* {{code|Homongous}} | * {{code|Homongous}} | ||
| | ||
|usage= | |usage= | ||
Line 45: | Line 43: | ||
|also= | |also= | ||
[[setSize|setSize()]] | [[setSize|setSize()]] [[resetSize|resetSize()]] | ||
|changes= | |changes= |
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.