resetProperty

 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 token id 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.

See Also

isPropertyEmpty(),

setProperty(),

getProperty()

Version Changes

• 1.3b51 - Added id parameter option.
• 1.3b68 - Token Property is now deleted from Token if the property is not a Campaign Property.
• 1.5.4 - Added mapname parameter option.