Difference between revisions of "Get property"

From Kolmafia
Jump to navigation Jump to search
imported>StDoodle
(Created page with '{{ #vardefine:name|get_property}}{{ #vardefine:return_type|string}}{{ FunctionPage| name={{#var:name}}| function_category=Miscellaneous| function1={{Function| name={{#var:name}…')
 
imported>Bale
m
Line 5: Line 5:
 
FunctionPage|
 
FunctionPage|
 
name={{#var:name}}|
 
name={{#var:name}}|
function_category=Miscellaneous|
 
  
 
function1={{Function|
 
function1={{Function|
Line 24: Line 23:
 
special=If a matching preference is not found, this function returns an empty string.|
 
special=If a matching preference is not found, this function returns an empty string.|
 
}}
 
}}
 +
 +
[[Category:Miscellaneous Functions]]

Revision as of 05:30, 22 May 2010

needs(code_samples);

Function Syntax

string get_property(string prop )

  • prop is the property to get

Looks for a global or appropriate user preference from the saved files (found in your "Settings" directory) and if it finds one that matches, it returns whatever value is stored for that preference.

CLI Equivalent

The CLI command "get" works similarly.

See Also

set_property()

Special

If a matching preference is not found, this function returns an empty string.