resetProperty: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:resetProperty moved to resetProperty) |
No edit summary |
||
| (10 intermediate revisions by 6 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples of usage.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=resetProperty | |name=resetProperty | ||
|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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
resetProperty(property) | |||
</ | resetProperty(property, tokenRef) | ||
resetProperty(property, tokenRef, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|property|The name of the property to reset.}} | |||
{{param|tokenRef|Either the token [[getSelected|{{code|id}}]] or [[getTokenName|Token Name]] 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.}} | |||
{{Note|Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.}} | |||
|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:Property Function]] | ||
[[Category:Token Function]] | [[Category:Token Function]] | ||
Latest revision as of 21:26, 17 May 2024
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, tokenRef)
resetProperty(property, tokenRef, mapname)Parameters
property- The name of the property to reset.tokenRef- Either the tokenidor Token Name of 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.
Token IDs are unique, but Token Names can be duplicated. Using Token Name when more than one token has the same name can produce unexpected results.
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.