getSize

 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 sizes returned on the Token Layer are:

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

 

The sizes returned on the Hidden, Object and Background Layers are:

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

 

Usage

getSize()
getSize(tokenRef)
getSize(tokenRef, mapname)

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. 

• mapname - The name 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.