getSize: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
VisualWikitext
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 6: Line 6:
Returns the [[Size]] of a [[Token]].
Returns the [[Size]] of a [[Token]].


The sizes returned on the Token Layer are:
{{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.}}
* {{code|Fine}}
* {{code|Diminutive}}
* {{code|Tiny}}
* {{code|Small}}
* {{code|Medium}}
* {{code|Large}}
* {{code|Huge}}
* {{code|Gargantuan}}
* {{code|Colossal}}
 
 
The sizes returned on the Object Layer are:
* {{code|1/6}}
* {{code|1/4}}
* {{code|1/3}}
* {{code|1/3}}
* {{code|1/3}}
* {{code|Medium}}
* {{code|Large}}
* {{code|Huge}}
* {{code|Homongous}}
 
{{Note|Tokens dropped onto the Object layer default to Freesize, unless you uncheck "Start Freesize" under Objects on the Interactions tab of [[MapTool_Preferences#Objects|Edit Preferences]].}}


|usage=
|usage=
<syntaxhighlight lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
getSize()
getSize()
getSize(id)
getSize(tokenRef)
getSize(id, mapname)
getSize(tokenRef, mapRef)
</syntaxhighlight>
</syntaxhighlight>
'''Parameter'''
'''Parameter'''
{{param|id|The token {{code|id}} of the token which has its [[Size]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] of the token which has its [[Size]] returned, defaults to the [[Current Token]]. {{TrustedParameter}} }}
{{param|mapname|The name of the map to find the token.  Defaults to the current map.}}
{{param|mapRef|The Name or ID of the map to find the token.  Defaults to the current map.}}
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}}


* Note that if the token is in native or free size, the value returned will be an empty string: ""
* Note that if the token is in native or free size, the value returned will be an empty string: ""


|also=
|also=
[[setSize|setSize()]]
[[setSize|setSize()]] [[resetSize|resetSize()]]


|changes=
|changes=

Latest revision as of 23:59, 11 May 2024

 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

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


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.

Usage

getSize()
getSize(tokenRef)
getSize(tokenRef, mapRef)

Parameter

  • tokenRef - Either the token id or Token Name of the token which has its Size returned, defaults to the Current Token.

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

  • mapRef - The Name or ID of the map to find the token. Defaults to the current map.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.


  • Note that if the token is in native or free size, the value returned will be an empty string: ""


See Also

setSize() resetSize()

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.
Retrieved from "https://wiki.rptools.info/index.php?title=getSize&oldid=35053"