diff options
Diffstat (limited to 'doc/classes/ProjectSettings.xml')
| -rw-r--r-- | doc/classes/ProjectSettings.xml | 159 |
1 files changed, 159 insertions, 0 deletions
diff --git a/doc/classes/ProjectSettings.xml b/doc/classes/ProjectSettings.xml new file mode 100644 index 0000000000..bec9525a45 --- /dev/null +++ b/doc/classes/ProjectSettings.xml @@ -0,0 +1,159 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="ProjectSettings" inherits="Object" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + Contains global variables accessible from everywhere. + </brief_description> + <description> + Contains global variables accessible from everywhere. Use the normal [Object] API, such as "ProjectSettings.get(variable)", "ProjectSettings.set(variable,value)" or "ProjectSettings.has(variable)" to access them. Variables stored in project.godot are also loaded into ProjectSettings, making this object very useful for reading custom game configuration options. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="add_property_info"> + <return type="void"> + </return> + <argument index="0" name="hint" type="Dictionary"> + </argument> + <description> + Add a custom property info to a property. The dictionary must contain: name:[String](the name of the property) and type:[int](see TYPE_* in [@Global Scope]), and optionally hint:[int](see PROPERTY_HINT_* in [@Global Scope]), hint_string:[String]. + Example: + [codeblock] + ProjectSettings.set("category/property_name", 0) + + var property_info = { + "name": "category/property_name", + "type": TYPE_INT, + "hint": PROPERTY_HINT_ENUM, + "hint_string": "one,two,three" + } + + ProjectSettings.add_property_info(property_info) + [/codeblock] + </description> + </method> + <method name="clear"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Clear the whole configuration (not recommended, may break things). + </description> + </method> + <method name="get_order" qualifiers="const"> + <return type="int"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return the order of a configuration value (influences when saved to the config file). + </description> + </method> + <method name="get_singleton" qualifiers="const"> + <return type="Object"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="globalize_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Convert a localized path (res://) to a full native OS path. + </description> + </method> + <method name="has" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + Return true if a configuration value is present. + </description> + </method> + <method name="has_singleton" qualifiers="const"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="load_resource_pack"> + <return type="bool"> + </return> + <argument index="0" name="pack" type="String"> + </argument> + <description> + </description> + </method> + <method name="localize_path" qualifiers="const"> + <return type="String"> + </return> + <argument index="0" name="path" type="String"> + </argument> + <description> + Convert a path to a localized path (res:// path). + </description> + </method> + <method name="property_can_revert"> + <return type="bool"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="property_get_revert"> + <return type="Variant"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <description> + </description> + </method> + <method name="save"> + <return type="int" enum="Error"> + </return> + <description> + </description> + </method> + <method name="save_custom"> + <return type="int" enum="Error"> + </return> + <argument index="0" name="file" type="String"> + </argument> + <description> + </description> + </method> + <method name="set_initial_value"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="value" type="Variant"> + </argument> + <description> + </description> + </method> + <method name="set_order"> + <return type="void"> + </return> + <argument index="0" name="name" type="String"> + </argument> + <argument index="1" name="pos" type="int"> + </argument> + <description> + Set the order of a configuration value (influences when saved to the config file). + </description> + </method> + </methods> + <constants> + </constants> +</class> |