getSize: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function geSize== {{ProposedChange}} Returns the Token:size of the current Token:token. The sizes returned are * Diminutive * Tiny * Small * Medium * Large * Huge * Giant * Gar...) |
No edit summary |
||
| (27 intermediate revisions by 8 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{ | {{MacroFunction | ||
Returns the [[ | |name=getSize | ||
|version=1.3b48 | |||
|description= | |||
Returns the [[Size]] of a [[Token]]. | |||
{{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.}} | |||
< | |||
[ | |usage= | ||
<syntaxhighlight lang="mtmacro" line> | |||
getSize() | |||
getSize(tokenRef) | |||
getSize(tokenRef, mapRef) | |||
</syntaxhighlight> | |||
'''Parameter''' | |||
{{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|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: "" | |||
|also= | |||
[[setSize|setSize()]] [[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, 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 tokenidor 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
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.