resetProperty: Difference between revisions
Jump to navigation
Jump to search
m (Oops.. first time editing.. missed the }}.. syntax corrected) |
No edit summary |
||
| Line 9: | Line 9: | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
resetProperty(property) | resetProperty(property) | ||
resetProperty(property, id) | resetProperty(property, id) | ||
resetProperty(property, id, mapname) | |||
</source> | </source> | ||
'''Parameters''' | '''Parameters''' | ||
{{param|property|The name of the property to reset.}} | {{param|property|The name of the property to reset.}} | ||
{{param|id|The token {{code|id}} of the token which has its property reset, defaults to the [[Current Token]]. {{TrustedParameter}} }} | {{param|id|The token {{code|id}} of the token which has its property reset, 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 25: | Line 25: | ||
{{change|1.3b51|Added {{code|id}} parameter option.}} | {{change|1.3b51|Added {{code|id}} parameter option.}} | ||
{{change|1.3b68|[[Token Property]] is now deleted from [[Token]]}} | {{change|1.3b68|[[Token Property]] is now deleted from [[Token]]}} | ||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Property Function]] | [[Category:Property Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 19:53, 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.
resetProperty() Function
• Introduced in version 1.3b48
Resets the specified Token Property on a specific Token so that it is empty and will return the default value when queried (if it has one).
Usage
resetProperty(property)
resetProperty(property, id)
resetProperty(property, id, mapname)Parameters
property- The name of the property to reset.id- The tokenidof the token which has its property reset, 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
idparameter option. - 1.3b68 - Token Property is now deleted from Token
- 1.5.4 - Added
mapnameparameter option.