getSize: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 26: | Line 26: | ||
'''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}} }} | ||
* Note that if the token is in native or free size, the value returned will be an empty string: "" | |||
|also= | |also= |
Revision as of 14:43, 15 August 2011
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:
Fine
Diminutive
Tiny
Small
Medium
Large
Huge
Gargantuan
Colossal
Usage
getSize()
getSize(id)
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.
- 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.