[DOCS] EditorFileSystemDirectory methods
This commit is contained in:
parent
d1084df81a
commit
d6a02e2022
1 changed files with 13 additions and 0 deletions
|
@ -4,6 +4,7 @@
|
||||||
A diretory for the resource filesystem.
|
A diretory for the resource filesystem.
|
||||||
</brief_description>
|
</brief_description>
|
||||||
<description>
|
<description>
|
||||||
|
A more generalized, low-level variation of the directory concept.
|
||||||
</description>
|
</description>
|
||||||
<tutorials>
|
<tutorials>
|
||||||
</tutorials>
|
</tutorials>
|
||||||
|
@ -16,6 +17,7 @@
|
||||||
<argument index="0" name="name" type="String">
|
<argument index="0" name="name" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="find_file_index" qualifiers="const">
|
<method name="find_file_index" qualifiers="const">
|
||||||
|
@ -24,6 +26,7 @@
|
||||||
<argument index="0" name="name" type="String">
|
<argument index="0" name="name" type="String">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_file" qualifiers="const">
|
<method name="get_file" qualifiers="const">
|
||||||
|
@ -32,12 +35,14 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the name of the file at index [code]idx[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_file_count" qualifiers="const">
|
<method name="get_file_count" qualifiers="const">
|
||||||
<return type="int">
|
<return type="int">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the number of files in this directory.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_file_import_is_valid" qualifiers="const">
|
<method name="get_file_import_is_valid" qualifiers="const">
|
||||||
|
@ -46,6 +51,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_file_path" qualifiers="const">
|
<method name="get_file_path" qualifiers="const">
|
||||||
|
@ -54,6 +60,7 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the path to the file at index [code]idx[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_file_type" qualifiers="const">
|
<method name="get_file_type" qualifiers="const">
|
||||||
|
@ -62,24 +69,28 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the file extension of the file at index [code]idx[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_name">
|
<method name="get_name">
|
||||||
<return type="String">
|
<return type="String">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the name of this directory.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_parent">
|
<method name="get_parent">
|
||||||
<return type="EditorFileSystemDirectory">
|
<return type="EditorFileSystemDirectory">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_path" qualifiers="const">
|
<method name="get_path" qualifiers="const">
|
||||||
<return type="String">
|
<return type="String">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the path to this directory.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_subdir">
|
<method name="get_subdir">
|
||||||
|
@ -88,12 +99,14 @@
|
||||||
<argument index="0" name="idx" type="int">
|
<argument index="0" name="idx" type="int">
|
||||||
</argument>
|
</argument>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the subdirectory at index [code]idx[/code].
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
<method name="get_subdir_count" qualifiers="const">
|
<method name="get_subdir_count" qualifiers="const">
|
||||||
<return type="int">
|
<return type="int">
|
||||||
</return>
|
</return>
|
||||||
<description>
|
<description>
|
||||||
|
Returns the number of subdirectories in this directory.
|
||||||
</description>
|
</description>
|
||||||
</method>
|
</method>
|
||||||
</methods>
|
</methods>
|
||||||
|
|
Loading…
Reference in a new issue