setPropertyType: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function setPropertyType== Sets the property type of the Current Token. <source lang="mtmacro" line> [h: type = setPropertyType(type)] <...) |
No edit summary |
||
| (12 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
|name=setPropertyType | |||
|version=1.3b48 | |||
|description= | |||
Sets the [[Introduction to Tokens#Property Type|Property Type]] of a [[Token]]. | |||
|usage= | |||
<syntaxhighlight lang="mtmacro" line> | |||
setPropertyType(type) | |||
setPropertyType(type, id) | |||
setPropertyType(type, id, mapRef) | |||
</syntaxhighlight> | |||
''Parameters''' | |||
{{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|mapRef|The Name or ID of the map to find the token. Defaults to the current map.}} | |||
|also= | |||
[ | [[getPropertyType|getPropertyType()]] | ||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[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.