setPropertyType: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Adding to Token Function category)
No edit summary
Line 9: Line 9:
<source lang="mtmacro" line>
<source lang="mtmacro" line>
setPropertyType(type)
setPropertyType(type)
</source>
<source lang="mtmacro" line>
setPropertyType(type, id)
setPropertyType(type, id)
setPropertyType(type, id, mapname)
</source>
</source>
''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|mapname|The name 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:Token Function]]
[[Category:Property Function]][[Category:Token Function]]

Revision as of 20:37, 15 August 2019

 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, mapname)

Parameters'

  • type - The property type to set on the token.
  • id - The token id of the token which has its property type set, 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.


See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.