isPropertyEmpty: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Adding to Property Function category)
No edit summary
Line 5: Line 5:
|description=
|description=
Returns {{true}} if the [[Token Property]] for a specific [[Token]] is empty. A [[Token Property]] is considered empty if it is {{code|NULL}}; if an empty string ({{code|""}}) has been assigned to it, it is not considered empty.
Returns {{true}} if the [[Token Property]] for a specific [[Token]] is empty. A [[Token Property]] is considered empty if it is {{code|NULL}}; if an empty string ({{code|""}}) has been assigned to it, it is not considered empty.
'''Note:''' If the token type sets a default value, this function will still see the property as empty. Try using [[json.isEmpty|json.isEmpty()]].


|usage=
|usage=
Line 25: Line 27:
[[resetProperty|resetProperty()]],  
[[resetProperty|resetProperty()]],  
[[getProperty|getProperty()]],  
[[getProperty|getProperty()]],  
[[setProperty|setProperty()]]
[[setProperty|setProperty()]],
 
[[json.isEmpty|json.isEmpty()]]
|changes=
|changes=
{{change|1.3b51|Added {{code|id}} parameter option.}}
{{change|1.3b51|Added {{code|id}} parameter option.}}

Revision as of 16:52, 2 February 2014

 This article is a stub, you can help the RPTools Wiki project by contributing content to expand this article.
 This article needs: Examples using the new functionality.

isPropertyEmpty() Function

Introduced in version 1.3b48
Returns true(1) if the Token Property for a specific Token is empty. A Token Property is considered empty if it is NULL; if an empty string ("") has been assigned to it, it is not considered empty. Note: If the token type sets a default value, this function will still see the property as empty. Try using json.isEmpty().

Usage

isPropertyEmpty(property)
isPropertyEmpty(property, id)

Parameters

  • property - The name of the property that has its value checked.
  • id - The token id of the token that has its value checked, defaults to the Current Token.

     Note: This parameter can only be used in a Trusted Macro

Example

[r, if(isPropertyEmpty("propertyName")): propertyName = someDefaultValue]

See Also

Version Changes

  • 1.3b51 - Added id parameter option.