setSize: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
(New page: ==Function getSize== Sets the size of the Current Token. The valid sizes are * Diminutive * Tiny * Small * Medium * Large * Huge * Giant * Gargantua...)
 
No edit summary
 
(27 intermediate revisions by 11 users not shown)
Line 1: Line 1:
==Function getSize==
{{MacroFunction
|name=setSize
|trusted=true
|version=1.3b48
|description=
Sets the size of a [[Token]] with one of the defined sizes according to each Grid Type. {{Note|The names of each size are based on the type of grid the map uses. The sizes can be found on the [[Token Size]] page.}} "Free" or "Native" are also valid values.


Sets the [[Token:size|size]] of the [[Token:Current Token|Current Token]].
|usage=
The valid sizes are
<syntaxhighlight lang="mtmacro" line>
* Diminutive
setSize(size)
* Tiny
setSize(size, id)
* Small
setSize(size, id, mapRef)
* Medium
</syntaxhighlight>
* Large
'''Parameters'''
* Huge
{{param|size|A [[Token Size]] to set the token to. Can be "Free" or "Native" as well.}}
* Giant
{{param|id|The token {{code|id}} of the token which will have its [[Token Size]] set. Defaults to the [[Current Token]].}}
* Gargantuan
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
* Colossal


===Usage===
The sizes available on the for Square grid maps are:
<source lang="mtmacro" line>
* {{code|Fine}}
[h: setSize(size)]
* {{code|Diminutive}}
</source>
* {{code|Tiny}}
* {{code|Small}}
* {{code|Medium}}
* {{code|Large}}
* {{code|Huge}}
* {{code|Gargantuan}}
* {{code|Colossal}}
&nbsp;
 
|examples=
To set the size of the current token to {{code|Medium}}:
<syntaxhighlight lang="mtmacro" line>
[h: setSize("Medium")]
</syntaxhighlight>
 
To set the size of the current token to whatever string is stored in the macro variable '''mySize''':
<syntaxhighlight lang="mtmacro" line>
[h: mySize = "Large"]
[h: setSize(mySize)]
</syntaxhighlight>
 
|also=
{{func|getSize}}  [[resetSize|resetSize()]]
 
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.5.4|Added {{code|mapname}} parameter option.}}
 
}}
[[Category:Token Function]]

Latest revision as of 23:59, 16 April 2024

setSize() Function

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

• Introduced in version 1.3b48
Sets the size of a Token with one of the defined sizes according to each Grid Type.
The names of each size are based on the type of grid the map uses. The sizes can be found on the Token Size page.
"Free" or "Native" are also valid values.

Usage

setSize(size)
setSize(size, id)
setSize(size, id, mapRef)

Parameters

  • size - A Token Size to set the token to. Can be "Free" or "Native" as well.
  • id - The token id of the token which will have its Token Size set. Defaults to the Current Token.
  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.

The sizes available on the for Square grid maps are:

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

 

Examples

To set the size of the current token to Medium: 
[h: setSize("Medium")]

To set the size of the current token to whatever string is stored in the macro variable mySize: 

[h: mySize = "Large"]
[h: setSize(mySize)]

See Also

getSize() resetSize()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://rptools.hyperbooks.com/index.php?title=setSize&oldid=35731"