setSize: Difference between revisions

Revision as of 16:48, 18 April 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.

setSize() Function

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

• Introduced in version 1.3b48

Sets the Size of a Token.

Grid Sizes and Scales

The valid sizes for each type of grid are documented below, where Medium is always 1 full grid cell. The Scale is a multiplier for the size of the image after configuring it to fit within the stated footprint. For example, the Huge size on a square grid occupies a 3x3 cell area and the image is scaled (1.0) to exactly fit that area. But the Large size on a hex grid is 3 hexes scaled down 10% (0.9) so as to keep the image slightly within the border of the 3 cells.

Hex Grid	Scale
`1/6`	0.408
`1/4`	0.5
`1/3`	0.577
`1/2`	0.707
`2/3`	0.816
`Medium`	1.0
`Large`	0.9 (3 cells)
`Huge`	1.0 (6 cells)

Square Grid	Scale
`Fine`	0.5
`Diminutive`	0.5
`Tiny`	0.5
`Small`	0.75
`Medium`	1.0
`Large`	1.0 (2x2)
`Huge`	1.0 (3x3)
`Gargantuan`	1.0 (4x4)
`Colossal`	1.0 (6x6)

Gridless	Scale	Gridless	Scale	Gridless	Scale
`-11`	0.086	`0`	1.0	`11`	7.43
`-10`	0.107	`1`	1.2	`12`	8.916
`-9`	0.134	`2`	1.44	`13`	10.699
`-8`	0.168	`3`	1.728	`14`	12.839
`-7`	0.21	`4`	2.074	`15`	15.407
`-6`	0.262	`5`	2.488	`16`	18.488
`-5`	0.328	`6`	2.986	`17`	22.186
`-4`	0.41	`7`	3.583	`18`	26.623
`-3`	0.512	`8`	4.3	`19`	31.948
`-2`	0.64	`9`	5.16	`20`	38.338
`-1`	0.8	`10`	6.192

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)]

Version Changes

1.3b51 - Added id parameter option.

@@ Line 7: / Line 7: @@
 Sets the [[Size]] of a [[Token]].
-The valid sizes for square grids are ('''Medium''' = 1 full cell):
+==Grid Sizes and Scales==
-* {{code|Fine}}
-* {{code|Diminutive}}
-* {{code|Tiny}}
-* {{code|Small}}
-* {{code|Medium}}
-* {{code|Large}}
-* {{code|Huge}}
-* {{code|Gargantuan}}
-* {{code|Colossal}}
-The valid sizes for hex grids are ('''Medium''' = 1 full cell):
+The valid sizes for each type of grid are documented below, where '''Medium''' is always 1 full grid cell.  The '''Scale''' is a multiplier for the size of the image after configuring it to fit within the stated footprint.  For example, the {{code|Huge}} size on a square grid occupies a 3x3 cell area and the image is scaled ('''1.0''') to exactly fit that area.  But the {{code|Large}} size on a hex grid is 3 hexes scaled down 10% ('''0.9''') so as to keep the image slightly within the border of the 3 cells.
-* {{code|1/6}}
-* {{code|1/4}}
+<table class="wikitable" border="1" style="border-collapse: collapse; float: left; margin-right: 2em">
-* {{code|1/3}}
+<tr style="background-color:#e0ddd5"><th>Hex Grid</th><th>Scale</th></tr>
-* {{code|1/2}}
+<tr><td>{{code|1/6}}<td>0.408
-* {{code|2/3}}
+<tr><td>{{code|1/4}}<td>0.5
-* {{code|Medium}}
+<tr><td>{{code|1/3}}<td>0.577
-* {{code|Large}}
+<tr><td>{{code|1/2}}<td>0.707
-* {{code|Huge}}
+<tr><td>{{code|2/3}}<td>0.816
+<tr><td>{{code|Medium}}<td>1.0
+<tr><td>{{code|Large}}<td>0.9 (3 cells)
+<tr><td>{{code|Huge}}<td>1.0 (6 cells)
+</table>
+<table class="wikitable" border="1" style="border-collapse: collapse">
+<tr style="background-color:#e0ddd5"><th>Square Grid</th><th>Scale</th></tr>
+<tr><td>{{code|Fine}}<td>0.5
+<tr><td>{{code|Diminutive}}<td>0.5
+<tr><td>{{code|Tiny}}<td>0.5
+<tr><td>{{code|Small}}<td>0.75
+<tr><td>{{code|Medium}}<td>1.0
+<tr><td>{{code|Large}}<td>1.0 (2x2)
+<tr><td>{{code|Huge}}<td>1.0 (3x3)
+<tr><td>{{code|Gargantuan}}<td>1.0 (4x4)
+<tr><td>{{code|Colossal}}<td>1.0 (6x6)
+</table>
+<table class="wikitable" border="1" style="border-collapse: collapse; margin-top: 1em">
+<tr style="background-color:#e0ddd5">
+<th>Gridless</th><th>Scale</th>
+<th>Gridless</th><th>Scale</th>
+<th>Gridless</th><th>Scale</th></tr>
+<tr><td>{{code|-11}} <td>0.086 <td>{{code|0}} <td>1.0   <td>{{code|11}} <td>7.43
+<tr><td>{{code|-10}} <td>0.107 <td>{{code|1}} <td>1.2   <td>{{code|12}} <td>8.916
+<tr><td>{{code|-9}} <td>0.134  <td>{{code|2}} <td>1.44  <td>{{code|13}} <td>10.699
+<tr><td>{{code|-8}} <td>0.168  <td>{{code|3}} <td>1.728 <td>{{code|14}} <td>12.839
+<tr><td>{{code|-7}} <td>0.21   <td>{{code|4}} <td>2.074 <td>{{code|15}} <td>15.407
+<tr><td>{{code|-6}} <td>0.262  <td>{{code|5}} <td>2.488 <td>{{code|16}} <td>18.488
+<tr><td>{{code|-5}} <td>0.328  <td>{{code|6}} <td>2.986 <td>{{code|17}} <td>22.186
+<tr><td>{{code|-4}} <td>0.41   <td>{{code|7}} <td>3.583 <td>{{code|18}} <td>26.623
+<tr><td>{{code|-3}} <td>0.512  <td>{{code|8}} <td>4.3   <td>{{code|19}} <td>31.948
+<tr><td>{{code|-2}} <td>0.64   <td>{{code|9}} <td>5.16  <td>{{code|20}} <td>38.338
+<tr><td>{{code|-1}} <td>0.8    <td>{{code|10}} <td>6.192<td colspan="2">
+</table>
-The valid sizes for gridless maps are:
-* {{code|-11}}
-* {{code|-10}}
-* {{code|-9}}
-* ...
-* {{code|18}}
-* {{code|19}}
-* {{code|20}}
 {{Clarify|It would be nice to include pictures that demonstrate how the grid cells are composed; at least for the hex grids.}}