isPropertyEmpty: Difference between revisions
Jump to navigation
Jump to search
Verisimilar (talk | contribs) m (Macros:Functions:isPropertyEmpty moved to isPropertyEmpty) |
No edit summary |
||
| (7 intermediate revisions by 5 users not shown) | |||
| Line 1: | Line 1: | ||
{{stub|Examples using the new functionality.}} | |||
{{MacroFunction | {{MacroFunction | ||
|name=isPropertyEmpty | |name=isPropertyEmpty | ||
|version=1.3b48 | |||
|description= | |description= | ||
Returns | 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= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
isPropertyEmpty(property) | |||
</ | isPropertyEmpty(property, id) | ||
isPropertyEmpty(property, id, mapname) | |||
</syntaxhighlight> | |||
'''Parameters''' | |||
{{param|property|The name of the property that has its value checked.}} | |||
{{param|id|The token {{code|id}} of the token that has its value checked, defaults to the [[Current Token]]. {{TrustedParameter}} }} | |||
{{param|mapname|The name of the map to find the token. Defaults to the current map.}} | |||
|example= | |example= | ||
< | <syntaxhighlight lang="mtmacro" line> | ||
[r, if(isPropertyEmpty("propertyName")): propertyName = someDefaultValue] | [r, if(isPropertyEmpty("propertyName")): propertyName = someDefaultValue] | ||
</ | </syntaxhighlight> | ||
|also= | |||
[[resetProperty|resetProperty()]], | |||
[[getProperty|getProperty()]], | |||
[[setProperty|setProperty()]], | |||
[[json.isEmpty|json.isEmpty()]] | |||
|changes= | |||
{{change|1.3b51|Added {{code|id}} parameter option.}} | |||
{{change|1.5.4|Added {{code|mapname}} parameter option.}} | |||
}} | }} | ||
[[Category:Token Function]] | [[Category:Token Function]][[Category:Property Function]] | ||
Latest 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 tokenidof 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
idparameter option. - 1.5.4 - Added
mapnameparameter option.