virtualx-engine/doc/classes/EditorFileSystemDirectory.xml
2018-01-13 11:43:42 +01:00

115 lines
3.2 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="EditorFileSystemDirectory" inherits="Object" category="Core" version="3.0-rc1">
<brief_description>
A diretory for the resource filesystem.
</brief_description>
<description>
A more generalized, low-level variation of the directory concept.
</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>
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">
<return type="int">
</return>
<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">
<return type="String">
</return>
<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">
<return type="bool">
</return>
<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">
<return type="String">
</return>
<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">
<return type="String">
</return>
<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">
<return type="EditorFileSystemDirectory">
</return>
<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>
<constants>
</constants>
</class>