setSize: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Added version.)
m (Updated with recent version changes.)
Line 1: Line 1:
{{stub|Examples of usage.}}
{{MacroFunction
{{MacroFunction
|name=getSize
|name=getSize
|trusted=true
|version=1.3b48
|version=1.3b48
|description=
|description=
Sets the [[Token:size|size]] of the [[Token:Current Token|Current Token]].
Sets the [[Size]] of a [[Token]].
The valid sizes are
 
* Diminutive
The valid sizes 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 22:
setSize(size)
setSize(size)
</source>
</source>
<source lang="mtmacro" line>
setSize(size, id)
</source>
'''Parameters'''
{{param|size|The [[Size]] to set the token to.}}
{{param|id|The token {{code|id}} of the token which has its [[Size]] set, defaults to the [[Current Token]].}}
|also=
[[getSize|getSize()]]
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
}}
}}
[[Category:Token Function]]
[[Category:Token Function]]

Revision as of 03:41, 31 March 2009

 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

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

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

The valid sizes are:

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

Usage

setSize(size)
setSize(size, id)

Parameters

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


See Also

Version Changes

  • 1.3b51 - Added id parameter option.