resetProperty: Difference between revisions
Jump to navigation
Jump to search
(New page: ==Function resetProperty== Resets the specified Token:token property so that it is empty and will return the default value when queried (if it has one). ===Usage=== <source lang="m...) |
No edit summary |
||
| (12 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
= | {{stub|Examples of usage.}} | ||
{{MacroFunction | |||
|name=resetProperty | |||
|version=1.3b48 | |||
|description= | |||
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= | |||
<syntaxhighlight lang="mtmacro" line> | |||
resetProperty(property) | |||
resetProperty(property, id) | |||
resetProperty(property, id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{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|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
== | |also= | ||
[[isPropertyEmpty|isPropertyEmpty()]], | |||
[ | [[setProperty|setProperty()]], | ||
[[getProperty|getProperty()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.3b68|[[Token Property]] is now deleted from [[Token]] if the property is not a [[Introduction_to_Properties#Campaign_Properties|Campaign Property]].}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | |||
[[Category:Property Function]] | |||
[[Category:Token Function]] | |||
Latest revision as of 22:10, 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.
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 if the property is not a Campaign Property.
- 1.5.4 - Added
mapnameparameter option.