getPropertyDefault: Difference between revisions

Latest revision as of 20:59, 20 April 2023

• Introduced in version 1.3b48

Returns the default value of a token property for the Current Token. If the default value contains nothing then an empty string ("") is returned.

getPropertyDefault(name)
getPropertyDefault(name, propType)

Parameter

name - The name of the property to get the default value of.
propType - The token type to get the property from. Defaults to the token type of the Current Token.

@@ Line 1: / Line 1: @@
-==Function getPropertyDefault==
+{{MacroFunction
+|name=getPropertyDefault
+|version=1.3b48
+|description=
+Returns the [[Introduction to Properties#Creating Properties| default value]] of a [[Introduction_to_Tokens#Properties| token property]] for the [[Current Token]]. If the [[Introduction to Properties#Creating Properties| default value]] contains nothing then an empty string ({{code|""}}) is returned.
-Returns the [[Campaign:property default value| default value]] of a [[Token:property| token property]] for the [[Token:Current Token|Current Token]]. If the [[Campaign:property default value| default value]] contains nothing then an empty string ("") is returned.
+|usage=
+<syntaxhighlight lang="mtmacro" line>
+getPropertyDefault(name)
+getPropertyDefault(name, propType)
+</syntaxhighlight>
-<source lang="mtmacro" line>
+'''Parameter'''
-[h: val = getPropertyDefault(name)]
+{{param|name|The name of the property to get the default value of.}}
-</source>
+{{param|propType|The token type to get the property from. Defaults to the token type of the [[Current Token]].}}
+}}
+[[Category:Token Function]][[Category:Property Function]]