setPropertyType: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
No edit summary |
||
| (8 intermediate revisions by 4 users not shown) | |||
| Line 4: | Line 4: | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Sets the [[Property Type]] of a [[Token]]. | Sets the [[Introduction to Tokens#Property Type|Property Type]] of a [[Token]]. | ||
|usage= | |usage= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
setPropertyType(type) | setPropertyType(type) | ||
setPropertyType(type, id) | setPropertyType(type, id) | ||
</ | setPropertyType(type, id, mapRef) | ||
</syntaxhighlight> | |||
''Parameters''' | ''Parameters''' | ||
{{param|type|The property type to set on the token.}} | {{param|type|The property type to set on the token.}} | ||
{{param|id|The token {{code|id}} of the token which has its property type set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its property type set, defaults to the [[Current Token]]. {{TrustedParameter}} }} | ||
{{param|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
|also= | |also= | ||
| Line 22: | Line 23: | ||
|changes= | |changes= | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Property Function]] | [[Category:Property Function]][[Category:Token Function]] | ||
Latest revision as of 23:59, 14 March 2023
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.
setPropertyType() Function
• Introduced in version 1.3b48
Sets the Property Type of a Token.
Usage
setPropertyType(type)
setPropertyType(type, id)
setPropertyType(type, id, mapRef)Parameters'
type- The property type to set on the token.id- The tokenidof the token which has its property type set, 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.
See Also
Version Changes
- 1.3b51 - Added
idparameter option. - 1.5.4 - Added
mapnameparameter option.