getSize: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 3: Line 3:
|version=1.3b48
|version=1.3b48
|description=
|description=
Returns the [[Token:size|size]] of the [[Token:Current Token|Current Token]].
Returns the [[Size]] of a [[Token]].
The sizes returned are
 
* Diminutive
The sizes returned are:
* Tiny
* {{code|Diminutive}}
* Small
* {{code|Tiny}}
* Medium
* {{code|Small}}
* Large
* {{code|Medium}}
* Huge
* {{code|Large}}
* Giant
* {{code|Huge}}
* Gargantuan
* {{code|Giant}}
* Colossal
* {{code|Gargantuan}}
* {{code|Colossal}}


|usage=
|usage=
Line 19: Line 20:
getSize()
getSize()
</source>
</source>
<source lang="mtmacro" line>
getSize(id)
</source>
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its [[Size]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }}
|also=
[[setSize|setSize()]]
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 03:35, 31 March 2009

getSize() Function

Introduced in version 1.3b48
Returns the Size of a Token.

The sizes returned are:

  • Diminutive
  • Tiny
  • Small
  • Medium
  • Large
  • Huge
  • Giant
  • Gargantuan
  • Colossal

Usage

getSize()
getSize(id)

Parameter

  • id - The token id of the token which has its Size returned, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro


See Also

Version Changes

  • 1.3b51 - Added id parameter option.