property_default_value

From Kolmafia
Revision as of 10:47, 23 December 2020 by Philmasterplus (talk | contribs) (Created page with "<onlyinclude>{{{{{format|Function2}}} |name=property_default_value |function1.return_type=string |function1.description=Returns the default value of a property, or an empty st...")
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Function Syntax

string property_default_valuestring name )

Returns the default value of a property, or an empty string if a default value does not exist.
  • name: Property name

All properties in data/defaults.txt have a default value.

This function was added in r17892.

Code Samples

Check if a property named autoBuyPriceLimit has a default value, and if so, print it.

if ( property_has_default( "autoBuyPriceLimit" ) )
{
   print( property_default_value( "autoBuyPriceLimit" ) );
}

See Also

get_all_properties() | property_exists() | property_has_default() | property_default_value() | get_property() | set_property() | remove_property() | rename_property()