setSize

From RPTools Wiki
Revision as of 22:20, 13 April 2011 by Azhrei (talk | contribs)
Jump to navigation Jump to search

 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.

setSize() 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 for square grids are (Medium = 1 full cell):

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

The valid sizes for hex grids are (Medium = 1 full cell):

  • 1/6
  • 1/4
  • 1/3
  • 1/2
  • 2/3
  • Medium
  • Large
  • Huge

The valid sizes for gridless maps are:

  • -11
  • -10
  • -9
  • ...
  • 18
  • 19
  • 20

Needs Clarification:
It would be nice to include pictures that demonstrate how the grid cells are composed; at least for the hex grids.

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.

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

Version Changes

  • 1.3b51 - Added id parameter option.