Skip to content

Latest commit

 

History

History
128 lines (79 loc) · 7.98 KB

class_editorfilesystemdirectory.rst

File metadata and controls

128 lines (79 loc) · 7.98 KB
Raw

EditorFileSystemDirectory

Inherits: Object<class_object>

Category: Core

Brief Description

A diretory for the resource filesystem.

Member Functions

int<class_int> find_dir_index<class_EditorFileSystemDirectory_find_dir_index> ( String<class_string> name ) const
int<class_int> find_file_index<class_EditorFileSystemDirectory_find_file_index> ( String<class_string> name ) const
String<class_string> get_file<class_EditorFileSystemDirectory_get_file> ( int<class_int> idx ) const
int<class_int> get_file_count<class_EditorFileSystemDirectory_get_file_count> ( ) const
bool<class_bool> get_file_import_is_valid<class_EditorFileSystemDirectory_get_file_import_is_valid> ( int<class_int> idx ) const
String<class_string> get_file_path<class_EditorFileSystemDirectory_get_file_path> ( int<class_int> idx ) const
String<class_string> get_file_type<class_EditorFileSystemDirectory_get_file_type> ( int<class_int> idx ) const
String<class_string> get_name<class_EditorFileSystemDirectory_get_name> ( )
EditorFileSystemDirectory<class_editorfilesystemdirectory> get_parent<class_EditorFileSystemDirectory_get_parent> ( )
String<class_string> get_path<class_EditorFileSystemDirectory_get_path> ( ) const
EditorFileSystemDirectory<class_editorfilesystemdirectory> get_subdir<class_EditorFileSystemDirectory_get_subdir> ( int<class_int> idx )
int<class_int> get_subdir_count<class_EditorFileSystemDirectory_get_subdir_count> ( ) const

Description

A more generalized, low-level variation of the directory concept.

Member Function Description

  • int<class_int> find_dir_index ( String<class_string> name ) const

Returns the index of the directory with name name or -1 if not found.

  • int<class_int> find_file_index ( String<class_string> name ) const

Returns the index of the file with name name or -1 if not found.

  • String<class_string> get_file ( int<class_int> idx ) const

Returns the name of the file at index idx.

  • int<class_int> get_file_count ( ) const

Returns the number of files in this directory.

  • bool<class_bool> get_file_import_is_valid ( int<class_int> idx ) const

Returns true if the file at index idx imported properly.

  • String<class_string> get_file_path ( int<class_int> idx ) const

Returns the path to the file at index idx.

  • String<class_string> get_file_type ( int<class_int> idx ) const

Returns the file extension of the file at index idx.

  • String<class_string> get_name ( )

Returns the name of this directory.

  • EditorFileSystemDirectory<class_editorfilesystemdirectory> get_parent ( )

Returns the parent directory for this directory or null if called on a directory at res:// or user://.

  • String<class_string> get_path ( ) const

Returns the path to this directory.

  • EditorFileSystemDirectory<class_editorfilesystemdirectory> get_subdir ( int<class_int> idx )

Returns the subdirectory at index idx.

  • int<class_int> get_subdir_count ( ) const

Returns the number of subdirectories in this directory.