isPropertyEmpty: Difference between revisions

From RPTools Wiki
Jump to navigation Jump to search
m (Conversion script moved page IsPropertyEmpty to isPropertyEmpty: Converting page titles to lowercase)
No edit summary
Line 9: Line 9:


|usage=
|usage=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
isPropertyEmpty(property)
isPropertyEmpty(property)
isPropertyEmpty(property, id)
isPropertyEmpty(property, id)
isPropertyEmpty(property, id, mapname)
isPropertyEmpty(property, id, mapname)
</source>
</syntaxhighlight>
'''Parameters'''
'''Parameters'''
{{param|property|The name of the property that has its value checked.}}
{{param|property|The name of the property that has its value checked.}}
Line 21: Line 21:


|example=
|example=
<source lang="mtmacro" line>
<syntaxhighlight lang="mtmacro" line>
[r, if(isPropertyEmpty("propertyName")): propertyName = someDefaultValue]
[r, if(isPropertyEmpty("propertyName")): propertyName = someDefaultValue]
</source>
</syntaxhighlight>


|also=
|also=

Revision as of 20:13, 15 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 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)
isPropertyEmpty(property, id, mapname)

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

  • mapname - The name of the map to find the token. Defaults to the current map.

Example

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

See Also

Version Changes

  • 1.3b51 - Added id parameter option.
  • 1.5.4 - Added mapname parameter option.