.. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/docs/gdscript/doc/classes/DirAccess.xml. .. _class_DirAccess: DirAccess ========= **Inherits:** :ref:`RefCounted` **<** :ref:`Object` .. container:: contribute There is currently no description for this class. Please help us by :ref:`contributing one `! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-------------------------+----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`include_hidden` | +-------------------------+----------------------------------------------------------------------------+ | :ref:`bool` | :ref:`include_navigational` | +-------------------------+----------------------------------------------------------------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`change_dir` **(** :ref:`String` to_dir **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`copy` **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`copy_absolute` **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`create_link` **(** :ref:`String` source, :ref:`String` target **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`current_is_dir` **(** **)** |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`dir_exists` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`dir_exists_absolute` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`file_exists` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_current_dir` **(** :ref:`bool` include_drive=true **)** |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_current_drive` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_directories` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_directories_at` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_drive_count` **(** **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_drive_name` **(** :ref:`int` idx **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_files` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`PackedStringArray` | :ref:`get_files_at` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`get_next` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`get_open_error` **(** **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`int` | :ref:`get_space_left` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_case_sensitive` **(** :ref:`String` path **)** |const| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`bool` | :ref:`is_link` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`list_dir_begin` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | void | :ref:`list_dir_end` **(** **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`make_dir` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`make_dir_absolute` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`make_dir_recursive` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`make_dir_recursive_absolute` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`DirAccess` | :ref:`open` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`String` | :ref:`read_link` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`remove` **(** :ref:`String` path **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`remove_absolute` **(** :ref:`String` path **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`rename` **(** :ref:`String` from, :ref:`String` to **)** | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Error` | :ref:`rename_absolute` **(** :ref:`String` from, :ref:`String` to **)** |static| | +---------------------------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_DirAccess_property_include_hidden: .. rst-class:: classref-property :ref:`bool` **include_hidden** .. rst-class:: classref-property-setget - void **set_include_hidden** **(** :ref:`bool` value **)** - :ref:`bool` **get_include_hidden** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_property_include_navigational: .. rst-class:: classref-property :ref:`bool` **include_navigational** .. rst-class:: classref-property-setget - void **set_include_navigational** **(** :ref:`bool` value **)** - :ref:`bool` **get_include_navigational** **(** **)** .. container:: contribute There is currently no description for this property. Please help us by :ref:`contributing one `! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_DirAccess_method_change_dir: .. rst-class:: classref-method :ref:`Error` **change_dir** **(** :ref:`String` to_dir **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_copy: .. rst-class:: classref-method :ref:`Error` **copy** **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_copy_absolute: .. rst-class:: classref-method :ref:`Error` **copy_absolute** **(** :ref:`String` from, :ref:`String` to, :ref:`int` chmod_flags=-1 **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_create_link: .. rst-class:: classref-method :ref:`Error` **create_link** **(** :ref:`String` source, :ref:`String` target **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_current_is_dir: .. rst-class:: classref-method :ref:`bool` **current_is_dir** **(** **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_dir_exists: .. rst-class:: classref-method :ref:`bool` **dir_exists** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_dir_exists_absolute: .. rst-class:: classref-method :ref:`bool` **dir_exists_absolute** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_file_exists: .. rst-class:: classref-method :ref:`bool` **file_exists** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_current_dir: .. rst-class:: classref-method :ref:`String` **get_current_dir** **(** :ref:`bool` include_drive=true **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_current_drive: .. rst-class:: classref-method :ref:`int` **get_current_drive** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_directories: .. rst-class:: classref-method :ref:`PackedStringArray` **get_directories** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_directories_at: .. rst-class:: classref-method :ref:`PackedStringArray` **get_directories_at** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_drive_count: .. rst-class:: classref-method :ref:`int` **get_drive_count** **(** **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_drive_name: .. rst-class:: classref-method :ref:`String` **get_drive_name** **(** :ref:`int` idx **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_files: .. rst-class:: classref-method :ref:`PackedStringArray` **get_files** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_files_at: .. rst-class:: classref-method :ref:`PackedStringArray` **get_files_at** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_next: .. rst-class:: classref-method :ref:`String` **get_next** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_open_error: .. rst-class:: classref-method :ref:`Error` **get_open_error** **(** **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_get_space_left: .. rst-class:: classref-method :ref:`int` **get_space_left** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_is_case_sensitive: .. rst-class:: classref-method :ref:`bool` **is_case_sensitive** **(** :ref:`String` path **)** |const| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_is_link: .. rst-class:: classref-method :ref:`bool` **is_link** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_list_dir_begin: .. rst-class:: classref-method :ref:`Error` **list_dir_begin** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_list_dir_end: .. rst-class:: classref-method void **list_dir_end** **(** **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_make_dir: .. rst-class:: classref-method :ref:`Error` **make_dir** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_make_dir_absolute: .. rst-class:: classref-method :ref:`Error` **make_dir_absolute** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_make_dir_recursive: .. rst-class:: classref-method :ref:`Error` **make_dir_recursive** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_make_dir_recursive_absolute: .. rst-class:: classref-method :ref:`Error` **make_dir_recursive_absolute** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_open: .. rst-class:: classref-method :ref:`DirAccess` **open** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_read_link: .. rst-class:: classref-method :ref:`String` **read_link** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_remove: .. rst-class:: classref-method :ref:`Error` **remove** **(** :ref:`String` path **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_remove_absolute: .. rst-class:: classref-method :ref:`Error` **remove_absolute** **(** :ref:`String` path **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_rename: .. rst-class:: classref-method :ref:`Error` **rename** **(** :ref:`String` from, :ref:`String` to **)** .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. rst-class:: classref-item-separator ---- .. _class_DirAccess_method_rename_absolute: .. rst-class:: classref-method :ref:`Error` **rename_absolute** **(** :ref:`String` from, :ref:`String` to **)** |static| .. container:: contribute There is currently no description for this method. Please help us by :ref:`contributing one `! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)`