asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

doc: Rename "@Global Scope" to "@GlobalScope"

Browse source 
Spaces in filenames are evil.
This commit is contained in:
Rémi Verschelde 2017-11-15 18:45:34 +01:00
parent 967bfb0c4a
commit e7701bb2de
17 changed files with 33 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
doc/classes/@GDScript.xml
View file

@ -196,7 +196,7 @@
<argument index="1" name="type" type="int">
</argument>
<description>
Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@Global Scope].
Converts from a type to another in the best way possible. The [code]type[/code] parameter uses the enum TYPE_* in [@GlobalScope].
[codeblock]
a = Vector2(1, 0)
# prints 1
@ -984,7 +984,7 @@
<argument index="0" name="what" type="Variant">
</argument>
<description>
Returns the internal type of the given Variant object, using the TYPE_* enum in [@Global Scope].
Returns the internal type of the given Variant object, using the TYPE_* enum in [@GlobalScope].
[codeblock]
p = parse_json('["a", "b", "c"]')
if typeof(p) == TYPE_ARRAY:

2
doc/classes/@Global Scope.xml → doc/classes/@GlobalScope.xml
View file

@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8" ?>
<class name="@Global Scope" category="Core" version="3.0-alpha">
<class name="@GlobalScope" category="Core" version="3.0-alpha">
<brief_description>
Global scope constants and variables.
</brief_description>

4
doc/classes/ConfigFile.xml
View file

@ -95,7 +95,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code].
Loads the config file specified as a parameter. The file's contents are parsed and loaded in the ConfigFile object which the method was called on. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code].
</description>
</method>
<method name="save">
@ -104,7 +104,7 @@
<argument index="0" name="path" type="String">
</argument>
<description>
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@Global Scope]. If the load was successful, the return value is [code]OK[/code].
Saves the contents of the ConfigFile object to the file specified as a parameter. The output file uses an INI-style structure. Returns one of the [code]OK[/code], [code]FAILED[/code] or [code]ERR_*[/code] constants listed in [@GlobalScope]. If the load was successful, the return value is [code]OK[/code].
</description>
</method>
<method name="set_value">

14
doc/classes/Directory.xml
View file

@ -34,7 +34,7 @@
</argument>
<description>
Change the currently opened directory to the one passed as an argument. The argument can be relative to the current directory (e.g. [code]newdir[/code] or [code]../newdir[/code]), or an absolute path (e.g. [code]/tmp/newdir[/code] or [code]res://somedir/newdir[/code]).
The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).
</description>
</method>
<method name="copy">
@ -46,7 +46,7 @@
</argument>
<description>
Copy the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
Returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
</description>
</method>
<method name="current_is_dir" qualifiers="const">
@ -146,7 +146,7 @@
</argument>
<description>
Create a directory. The argument can be relative to the current directory, or an absolute path. The target directory should be placed in an already existing directory (to create the full path recursively, see [method make_dir_recursive]).
The method returns one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
The method returns one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
</description>
</method>
<method name="make_dir_recursive">
@ -156,7 +156,7 @@
</argument>
<description>
Create a target directory and all necessary intermediate directories in its path, by calling [method make_dir] recursively. The argument can be relative to the current directory, or an absolute path.
Return one of the error code constants defined in [@Global Scope] (OK, FAILED or ERR_*).
Return one of the error code constants defined in [@GlobalScope] (OK, FAILED or ERR_*).
</description>
</method>
<method name="open">
@ -166,7 +166,7 @@
</argument>
<description>
Open an existing directory of the filesystem. The [i]path[/i] argument can be within the project tree ([code]res://folder[/code]), the user directory ([code]user://folder[/code]) or an absolute path of the user filesystem (e.g. [code]/tmp/folder[/code] or [code]C:\tmp\folder[/code]).
The method returns one of the error code constants defined in [@Global Scope] (OK or ERR_*).
The method returns one of the error code constants defined in [@GlobalScope] (OK or ERR_*).
</description>
</method>
<method name="remove">
@ -176,7 +176,7 @@
</argument>
<description>
Delete the target file or an empty directory. The argument can be relative to the current directory, or an absolute path. If the target directory is not empty, the operation will fail.
Return one of the error code constants defined in [@Global Scope] (OK or FAILED).
Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).
</description>
</method>
<method name="rename">
@ -188,7 +188,7 @@
</argument>
<description>
Rename (move) the [i]from[/i] file to the [i]to[/i] destination. Both arguments should be paths to files, either relative or absolute. If the destination file exists and is not access-protected, it will be overwritten.
Return one of the error code constants defined in [@Global Scope] (OK or FAILED).
Return one of the error code constants defined in [@GlobalScope] (OK or FAILED).
</description>
</method>
</methods>

2
doc/classes/EditorInterface.xml
View file

@ -127,7 +127,7 @@
<return type="int" enum="Error">
</return>
<description>
Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@Global Scope] constants.
Saves the scene. Returns either OK or ERR_CANT_CREATE. See [@GlobalScope] constants.
</description>
</method>
<method name="save_scene_as">

2
doc/classes/EditorSettings.xml
View file

@ -23,7 +23,7 @@
<argument index="0" name="info" 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].
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 [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String].
Example:
[codeblock]
editor_settings.set("category/property_name", 0)

2
doc/classes/File.xml
View file

@ -120,7 +120,7 @@
<return type="int" enum="Error">
</return>
<description>
Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@Global Scope].
Returns the last error that happened when trying to perform operations. Compare with the [code]ERR_FILE_*[/code] constants from [@GlobalScope].
</description>
</method>
<method name="get_float" qualifiers="const">

10
doc/classes/Input.xml
View file

@ -75,7 +75,7 @@
<argument index="1" name="axis" type="int">
</argument>
<description>
Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@Global Scope])
Returns the current value of the joypad axis at given index (see [code]JOY_*[/code] constants in [@GlobalScope])
</description>
</method>
<method name="get_joy_axis_index_from_string">
@ -209,7 +209,7 @@
<argument index="1" name="button" type="int">
</argument>
<description>
Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@Global Scope])
Returns [code]true[/code] if you are pressing the joypad button. (see [code]JOY_*[/code] constants in [@GlobalScope])
</description>
</method>
<method name="is_joy_known">
@ -218,7 +218,7 @@
<argument index="0" name="device" type="int">
</argument>
<description>
Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@Global Scope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them.
Returns [code]true[/code] if the system knows the specified device. This means that it sets all button and axis indices exactly as defined in the [code]JOY_*[/code] constants (see [@GlobalScope]). Unknown joypads are not expected to match these constants, but you can still retrieve events from them.
</description>
</method>
<method name="is_key_pressed" qualifiers="const">
@ -227,7 +227,7 @@
<argument index="0" name="scancode" type="int">
</argument>
<description>
Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@Global Scope].
Returns [code]true[/code] if you are pressing the key. You can pass [code]KEY_*[/code], which are pre-defined constants listed in [@GlobalScope].
</description>
</method>
<method name="is_mouse_button_pressed" qualifiers="const">
@ -236,7 +236,7 @@
<argument index="0" name="button" type="int">
</argument>
<description>
Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@Global Scope].
Returns [code]true[/code] if you are pressing the mouse button. You can pass [code]BUTTON_*[/code], which are pre-defined constants listed in [@GlobalScope].
</description>
</method>
<method name="joy_connection_changed">

2
doc/classes/InputEventMouse.xml
View file

@ -57,7 +57,7 @@
</methods>
<members>
<member name="button_mask" type="int" setter="set_button_mask" getter="get_button_mask">
Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@Global Scope].
Mouse button mask identifier, one of or a bitwise combination of the BUTTON_MASK_* constants in [@GlobalScope].
</member>
<member name="global_position" type="Vector2" setter="set_global_position" getter="get_global_position">
Mouse position relative to the current [Viewport] when used in [method Control._gui_input], otherwise is at 0,0.

2
doc/classes/InputEventMouseButton.xml
View file

@ -65,7 +65,7 @@
</methods>
<members>
<member name="button_index" type="int" setter="set_button_index" getter="get_button_index">
Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@Global Scope].
Mouse button identifier, one of the BUTTON_* or BUTTON_WHEEL_* constants in [@GlobalScope].
</member>
<member name="doubleclick" type="bool" setter="set_doubleclick" getter="is_doubleclick">
If [code]true[/code] the mouse button's state is a double-click. If [code]false[/code] the mouse button's state is released.

4
doc/classes/JSONParseResult.xml
View file

@ -70,13 +70,13 @@
</methods>
<members>
<member name="error" type="int" setter="set_error" getter="get_error" enum="Error">
The error type if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants.
The error type if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants.
</member>
<member name="error_line" type="int" setter="set_error_line" getter="get_error_line">
The line number where the error occurred if JSON source was not successfully parsed.
</member>
<member name="error_string" type="String" setter="set_error_string" getter="get_error_string">
The error message if JSON source was not successfully parsed. See [@Global Scope]ERR_* constants.
The error message if JSON source was not successfully parsed. See [@GlobalScope]ERR_* constants.
</member>
<member name="result" type="Variant" setter="set_result" getter="get_result">
A [Variant] containing the parsed JSON. Use typeof() to check if it is what you expect. For example, if JSON source starts with braces [code]{}[/code] a [Dictionary] will be returned, if JSON source starts with array braces [code][][/code] an [Array] will be returned.

6
doc/classes/Object.xml
View file

@ -28,7 +28,7 @@
<return type="Array">
</return>
<description>
Returns the object's property list as an [Array] of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Returns the object's property list as an [Array] of dictionaries. Dictionaries must contain: name:String, type:int (see TYPE_* enum in [@GlobalScope]) and optionally: hint:int (see PROPERTY_HINT_* in [@GlobalScope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@GlobalScope]).
</description>
</method>
<method name="_init" qualifiers="virtual">
@ -66,7 +66,7 @@
<argument index="1" name="arguments" type="Array" default="[ ]">
</argument>
<description>
Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing "name" and "type" (from [@Global Scope] TYPE_*).
Adds a user-defined [code]signal[/code]. Arguments are optional, but can be added as an [Array] of dictionaries, each containing "name" and "type" (from [@GlobalScope] TYPE_*).
</description>
</method>
<method name="call" qualifiers="vararg">
@ -212,7 +212,7 @@
<return type="Array">
</return>
<description>
Returns the list of properties as an [Array] of dictionaries. Dictionaries contain: name:String, type:int (see TYPE_* enum in [@Global Scope]) and optionally: hint:int (see PROPERTY_HINT_* in [@Global Scope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@Global Scope]).
Returns the list of properties as an [Array] of dictionaries. Dictionaries contain: name:String, type:int (see TYPE_* enum in [@GlobalScope]) and optionally: hint:int (see PROPERTY_HINT_* in [@GlobalScope]), hint_string:String, usage:int (see PROPERTY_USAGE_* in [@GlobalScope]).
</description>
</method>
<method name="get_script" qualifiers="const">

2
doc/classes/ProjectSettings.xml
View file

@ -17,7 +17,7 @@
<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].
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 [@GlobalScope]), and optionally hint:[int](see PROPERTY_HINT_* in [@GlobalScope]), hint_string:[String].
Example:
[codeblock]
ProjectSettings.set("category/property_name", 0)

2
editor/doc/doc_data.cpp
View file

@ -530,7 +530,7 @@ void DocData::generate(bool p_basic_types) {
{
String cname = "@Global Scope";
String cname = "@GlobalScope";
class_list[cname] = ClassDoc();
ClassDoc &c = class_list[cname];
c.name = cname;

2
editor/editor_help.cpp
View file

@ -555,7 +555,7 @@ void EditorHelp::_class_desc_select(const String &p_select) {
if (select.find(".") != -1) {
class_name = select.get_slice(".", 0);
} else {
class_name = "@Global Scope";
class_name = "@GlobalScope";
}
emit_signal("go_to_help", "class_enum:" + class_name + ":" + select);
return;

2
modules/gdscript/gd_editor.cpp
View file

@ -2798,7 +2798,7 @@ Error GDScriptLanguage::lookup_code(const String &p_code, const String &p_symbol
}
} else {
r_result.type = ScriptLanguage::LookupResult::RESULT_CLASS_CONSTANT;
r_result.class_name = "@Global Scope";
r_result.class_name = "@GlobalScope";
r_result.class_member = p_symbol;
return OK;
}

4
modules/mono/editor/bindings_generator.cpp
View file

@ -320,9 +320,9 @@ Error BindingsGenerator::generate_cs_core_project(const String &p_output_dir, bo
int global_constants_count = GlobalConstants::get_global_constant_count();
if (global_constants_count > 0) {
Map<String, DocData::ClassDoc>::Element *match = EditorHelp::get_doc_data()->class_list.find("@Global Scope");
Map<String, DocData::ClassDoc>::Element *match = EditorHelp::get_doc_data()->class_list.find("@GlobalScope");
ERR_EXPLAIN("Could not find `@Global Scope` in DocData");
ERR_EXPLAIN("Could not find `@GlobalScope` in DocData");
ERR_FAIL_COND_V(!match, ERR_BUG);
const DocData::ClassDoc &global_scope_doc = match->value();