diff options
Diffstat (limited to 'doc/base/classes.xml')
| -rw-r--r-- | doc/base/classes.xml | 25 |
1 files changed, 13 insertions, 12 deletions
diff --git a/doc/base/classes.xml b/doc/base/classes.xml index 1dff307959..164557578d 100644 --- a/doc/base/classes.xml +++ b/doc/base/classes.xml @@ -9608,7 +9608,8 @@ This approximation makes straight segments between each point, then subdivides t <brief_description> Directory type. </brief_description> - <description>Directory type. Is used to manage directories and their content (not restricted to the project folder). + <description> + Directory type. Is used to manage directories and their content (not restricted to the project folder). How to iterate through the files of a directory example: @@ -9633,21 +9634,21 @@ func dir(path): <argument index="0" name="path" type="String"> </argument> <description> -Opens a directory to work with. Needs a path, example "res://folder" + Opens a directory to work with. Needs a path, example "res://folder" </description> </method> <method name="list_dir_begin"> <return type="bool"> </return> <description> -Loads all file names of the current directory (prepares the get_next() function). + Loads all file names of the current directory (prepares the get_next() function). </description> </method> <method name="get_next"> <return type="String"> </return> <description> -Is used to iterate through the files of the current directory. Returns the name(no path) of the current file/directory, it also contains "." and ".." . + Is used to iterate through the files of the current directory. Returns the name(no path) of the current file/directory, it also contains "." and ".." . Returns an empty String "" at the end of the list. </description> </method> @@ -9655,12 +9656,12 @@ Returns an empty String "" at the end of the list. <return type="bool"> </return> <description> -Returns true if the current file you are looking at with get_next() is a directory or "." or ".." otherwise false. + Returns true if the current file you are looking at with get_next() is a directory or "." or ".." otherwise false. </description> </method> <method name="list_dir_end"> <description> -Run this to empty the list of remaining files in get_next(). You can use it to end the iteration, as soon as your goal is reached. + Run this to empty the list of remaining files in get_next(). You can use it to end the iteration, as soon as your goal is reached. </description> </method> <method name="get_drive_count"> @@ -9683,14 +9684,14 @@ Run this to empty the list of remaining files in get_next(). You can use it to e <argument index="0" name="todir" type="String"> </argument> <description> -Needs a path or name to the next directory. When the target directory is in the current directory you can use "newfolder" otherwise you need the full path "res://currentfolder/newfolder" + Needs a path or name to the next directory. When the target directory is in the current directory you can use "newfolder" otherwise you need the full path "res://currentfolder/newfolder" </description> </method> <method name="get_current_dir"> <return type="String"> </return> <description> -Returns a path to the current directory, example: "res://folder" + Returns a path to the current directory, example: "res://folder" </description> </method> <method name="make_dir"> @@ -9723,7 +9724,7 @@ Returns a path to the current directory, example: "res://folder" <argument index="0" name="name" type="String"> </argument> <description> -Returns true if directory exists otherwise false. Needs a path, example: "res://folder" + Returns true if directory exists otherwise false. Needs a path, example: "res://folder" </description> </method> <method name="get_space_left"> @@ -18475,13 +18476,13 @@ verify_host will check the SSL identity of the host if set to true. </description> <methods> <method name="set_navigation_polygon"> - <argument index="0" name="navpoly" type="Object"> + <argument index="0" name="navpoly" type="NavigationPolygon"> </argument> <description> </description> </method> <method name="get_navigation_polygon" qualifiers="const"> - <return type="Object"> + <return type="NavigationPolygon"> </return> <description> </description> @@ -36428,7 +36429,7 @@ This method controls whether the position between two cached points is interpola <argument index="1" name="y" type="int"> </argument> <description> - Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). + Return whether the referenced cell is transposed, i.e. the X and Y axes are swapped (mirroring with regard to the (1,1) vector). </description> </method> <method name="clear"> |