Difference between revisions of "Rename property"

From Kolmafia
Jump to navigation Jump to search
m
m
 
Line 6: Line 6:
 
|function1.param1.type=string
 
|function1.param1.type=string
 
|function1.param1.description=Old property name
 
|function1.param1.description=Old property name
|function2.param1=new_name
+
|function1.param2=new_name
|function2.param1.type=string
+
|function1.param2.type=string
|function2.param1.description=New property name
+
|function1.param2.description=New property name
 
|description=To rename a property, the following conditions must be met:
 
|description=To rename a property, the following conditions must be met:
  

Latest revision as of 10:53, 23 December 2020

Function Syntax

boolean rename_propertystring old_name, string new_name )

Renames a property. Returns true on success, false on failure.
  • old_name: Old property name
  • new_name: New property name

To rename a property, the following conditions must be met:

  • Both old_name and new_name must not be a built-in property.
  • old_name must exist.
  • new_name must not exist.

This function was added in r17892.

Code Samples

Rename a property named myOldPref to myNewPref.

if ( !rename_property( "myOldPref", "myNewPref" ) )
{
   abort( "Failed to rename property" );
}

See Also

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