diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/classes/Camera2D.xml | 10 | ||||
| -rw-r--r-- | doc/classes/EditorFileSystemDirectory.xml | 13 | ||||
| -rw-r--r-- | doc/classes/EditorScript.xml | 4 |
3 files changed, 26 insertions, 1 deletions
diff --git a/doc/classes/Camera2D.xml b/doc/classes/Camera2D.xml index 86c89bf4ca..c95691d07f 100644 --- a/doc/classes/Camera2D.xml +++ b/doc/classes/Camera2D.xml @@ -23,6 +23,7 @@ <return type="void"> </return> <description> + Removes any [code]Camera2D[/code] from the ancestor [Viewport]'s internal currently-assigned camera. </description> </method> <method name="force_update_scroll"> @@ -43,24 +44,28 @@ <return type="Vector2"> </return> <description> + Returns the location of the [code]Camera2D[/code]'s screen-center, relative to the origin. </description> </method> <method name="get_custom_viewport" qualifiers="const"> <return type="Node"> </return> <description> + Returns the [Viewport] used by the camera if it is not using the default viewport. </description> </method> <method name="get_h_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the horizontal offset of the camera. </description> </method> <method name="get_v_offset" qualifiers="const"> <return type="float"> </return> <description> + Returns the vertical offset of the camera. </description> </method> <method name="make_current"> @@ -84,6 +89,7 @@ <argument index="0" name="viewport" type="Node"> </argument> <description> + Assigns a custom [Viewport] node to the [code]Camera2D[/code]. If [code]viewport[/code] is not a [Viewport], it re-assigns the default viewport instead. </description> </method> <method name="set_h_offset"> @@ -92,6 +98,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> + The camera's horizontal offset is set to [code]ofs[/code]. </description> </method> <method name="set_v_offset"> @@ -100,6 +107,7 @@ <argument index="0" name="ofs" type="float"> </argument> <description> + The camera's vertical offset is set to [code]ofs[/code]. </description> </method> </methods> @@ -170,8 +178,10 @@ </members> <constants> <constant name="ANCHOR_MODE_FIXED_TOP_LEFT" value="0" enum="AnchorMode"> + The camera's position is fixed so that the top-left corner is always at the origin. </constant> <constant name="ANCHOR_MODE_DRAG_CENTER" value="1" enum="AnchorMode"> + The camera's position takes into account vertical/horizontal offsets and the screen size. </constant> </constants> </class> diff --git a/doc/classes/EditorFileSystemDirectory.xml b/doc/classes/EditorFileSystemDirectory.xml index 50b6f3680c..1a2f73a683 100644 --- a/doc/classes/EditorFileSystemDirectory.xml +++ b/doc/classes/EditorFileSystemDirectory.xml @@ -4,6 +4,7 @@ A diretory for the resource filesystem. </brief_description> <description> + A more generalized, low-level variation of the directory concept. </description> <tutorials> </tutorials> @@ -16,6 +17,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="find_file_index" qualifiers="const"> @@ -24,6 +26,7 @@ <argument index="0" name="name" type="String"> </argument> <description> + Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found. </description> </method> <method name="get_file" qualifiers="const"> @@ -32,12 +35,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the name of the file at index [code]idx[/code]. </description> </method> <method name="get_file_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of files in this directory. </description> </method> <method name="get_file_import_is_valid" qualifiers="const"> @@ -46,6 +51,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns [code]true[/code] if the file at index [code]idx[/code] imported properly. </description> </method> <method name="get_file_path" qualifiers="const"> @@ -54,6 +60,7 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the path to the file at index [code]idx[/code]. </description> </method> <method name="get_file_type" qualifiers="const"> @@ -62,24 +69,28 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the file extension of the file at index [code]idx[/code]. </description> </method> <method name="get_name"> <return type="String"> </return> <description> + Returns the name of this directory. </description> </method> <method name="get_parent"> <return type="EditorFileSystemDirectory"> </return> <description> + Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code]. </description> </method> <method name="get_path" qualifiers="const"> <return type="String"> </return> <description> + Returns the path to this directory. </description> </method> <method name="get_subdir"> @@ -88,12 +99,14 @@ <argument index="0" name="idx" type="int"> </argument> <description> + Returns the subdirectory at index [code]idx[/code]. </description> </method> <method name="get_subdir_count" qualifiers="const"> <return type="int"> </return> <description> + Returns the number of subdirectories in this directory. </description> </method> </methods> diff --git a/doc/classes/EditorScript.xml b/doc/classes/EditorScript.xml index fcc297a1e8..97f126e7f7 100644 --- a/doc/classes/EditorScript.xml +++ b/doc/classes/EditorScript.xml @@ -9,7 +9,7 @@ [codeblock] tool extends EditorScript - + func _run(): print("Hello from the Godot Editor!") [/codeblock] @@ -33,6 +33,8 @@ <argument index="0" name="node" type="Node"> </argument> <description> + Adds [code]node[/code] as a child of the root node in the editor context. + WARNING: The implementation of this method is currently disabled. </description> </method> <method name="get_editor_interface"> |