2017-09-12 22:42:36 +02:00
|
|
|
<?xml version="1.0" encoding="UTF-8" ?>
|
2018-06-14 17:37:51 +02:00
|
|
|
<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0.4">
|
2017-09-12 22:42:36 +02:00
|
|
|
<brief_description>
|
|
|
|
A diretory for the resource filesystem.
|
|
|
|
</brief_description>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
A more generalized, low-level variation of the directory concept.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
<tutorials>
|
|
|
|
</tutorials>
|
|
|
|
<demos>
|
|
|
|
</demos>
|
|
|
|
<methods>
|
|
|
|
<method name="find_dir_index" qualifiers="const">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="name" type="String">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the index of the directory with name [code]name[/code] or [code]-1[/code] if not found.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="find_file_index" qualifiers="const">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="name" type="String">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the index of the file with name [code]name[/code] or [code]-1[/code] if not found.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_file" qualifiers="const">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the name of the file at index [code]idx[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_file_count" qualifiers="const">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the number of files in this directory.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_file_import_is_valid" qualifiers="const">
|
|
|
|
<return type="bool">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns [code]true[/code] if the file at index [code]idx[/code] imported properly.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_file_path" qualifiers="const">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the path to the file at index [code]idx[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_file_type" qualifiers="const">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the file extension of the file at index [code]idx[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_name">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the name of this directory.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_parent">
|
|
|
|
<return type="EditorFileSystemDirectory">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the parent directory for this directory or null if called on a directory at [code]res://[/code] or [code]user://[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_path" qualifiers="const">
|
|
|
|
<return type="String">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the path to this directory.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_subdir">
|
|
|
|
<return type="EditorFileSystemDirectory">
|
|
|
|
</return>
|
|
|
|
<argument index="0" name="idx" type="int">
|
|
|
|
</argument>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the subdirectory at index [code]idx[/code].
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
<method name="get_subdir_count" qualifiers="const">
|
|
|
|
<return type="int">
|
|
|
|
</return>
|
|
|
|
<description>
|
2017-12-06 19:56:15 +01:00
|
|
|
Returns the number of subdirectories in this directory.
|
2017-09-12 22:42:36 +02:00
|
|
|
</description>
|
|
|
|
</method>
|
|
|
|
</methods>
|
|
|
|
<constants>
|
|
|
|
</constants>
|
|
|
|
</class>
|