Difference between revisions of "Get all properties"
Jump to navigation
Jump to search
imported>Smelltastic |
imported>Smelltastic |
||
| Line 13: | Line 13: | ||
return_type={{#var:return_type}}| | return_type={{#var:return_type}}| | ||
return_also={{#var:return_also}}| | return_also={{#var:return_also}}| | ||
| + | parameter1={{Param|string|filter}}| | ||
| + | p1desc={{pspan|filter}} specifies a filter on which properties to return.| | ||
| + | parameter2={{Param|boolean|global}}| | ||
| + | p2desc={{pspan|global}} specifies whether to get properties from the GLOBAL prefs file (true) or the NAME prefs file (false) of the current user.| | ||
}}| | }}| | ||
| − | function_description=Returns a map from name to a boolean which is true if the property is supported by KoLmafia itself or false if its for/by user scripts | + | function_description=Returns a map from name to a boolean which is true if the property is supported by KoLmafia itself or false if its for/by user scripts.| |
needscode=yes| | needscode=yes| | ||
| Line 22: | Line 26: | ||
}} | }} | ||
| − | [[Category: | + | [[Category:Miscellaneous Functions]] |
Latest revision as of 02:01, 22 March 2017
needs(code_samples);
Function Syntax
boolean [string] get_all_properties(string filter ,boolean global )
- filter specifies a filter on which properties to return.
- global specifies whether to get properties from the GLOBAL prefs file (true) or the NAME prefs file (false) of the current user.
Returns a map from name to a boolean which is true if the property is supported by KoLmafia itself or false if its for/by user scripts.