resetProperty: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Added version.) |
Verisimilar (talk | contribs) m (Updated with recent version changes.) |
||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=resetProperty | |name=resetProperty | ||
|version=1.3b48 | |version=1.3b48 | ||
|description= | |description= | ||
Resets the specified [[Token | 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= | |usage= | ||
<source lang="mtmacro" line> | <source lang="mtmacro" line> | ||
resetProperty(property) | |||
</source> | </source> | ||
<source lang="mtmacro" line> | |||
resetProperty(property, id) | |||
</source> | |||
'''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}} }} | |||
|also= | |||
[[isPropertyEmpty|isPropertyEmpty()]], | |||
[[setProperty|setProperty()]], | |||
[[getProperty|getProperty()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
}} | }} | ||
[[Category:Property Function]] | [[Category:Property Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Revision as of 04:15, 31 March 2009
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)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.
See Also
Version Changes
- 1.3b51 - Added
idparameter option.