Documentation
¶
Overview ¶
A more generalized, low-level variation of the directory concept.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsEditorFileSystemDirectory() Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) FindDirIndex(name string) int
- func (self Instance) FindFileIndex(name string) int
- func (self Instance) GetFile(idx int) string
- func (self Instance) GetFileCount() int
- func (self Instance) GetFileImportIsValid(idx int) bool
- func (self Instance) GetFilePath(idx int) string
- func (self Instance) GetFileScriptClassExtends(idx int) string
- func (self Instance) GetFileScriptClassName(idx int) string
- func (self Instance) GetFileType(idx int) string
- func (self Instance) GetName() string
- func (self Instance) GetParent() Instance
- func (self Instance) GetPath() string
- func (self Instance) GetSubdir(idx int) Instance
- func (self Instance) GetSubdirCount() int
- func (self Instance) ID() ID
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) Virtual(name string) reflect.Value
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Advanced ¶
type Advanced = class
Advanced exposes a 1:1 low-level instance of the class, undocumented, for those who know what they are doing.
type Extension ¶
Extension can be embedded in a new struct to create an extension of this class. T should be the type that is embedding this Extension
func (*Extension[T]) AsEditorFileSystemDirectory ¶
type ID ¶
ID is a typed object ID (reference) to an instance of this class, use it to store references to objects with unknown lifetimes, as an ID will not panic on use if the underlying object has been destroyed.
type Instance ¶
type Instance [1]gdclass.EditorFileSystemDirectory
Instance of the class with convieniently typed arguments and results.
var Nil Instance
Nil is a nil/null instance of the class. Equivalent to the zero value.
func (Instance) AsEditorFileSystemDirectory ¶
func (Instance) FindDirIndex ¶
Returns the index of the directory with name 'name' or -1 if not found.
func (Instance) FindFileIndex ¶
Returns the index of the file with name 'name' or -1 if not found.
func (Instance) GetFileCount ¶
Returns the number of files in this directory.
func (Instance) GetFileImportIsValid ¶
Returns true if the file at index 'idx' imported properly.
func (Instance) GetFilePath ¶
Returns the path to the file at index 'idx'.
func (Instance) GetFileScriptClassExtends ¶
Returns the base class of the script class defined in the file at index 'idx'. If the file doesn't define a script class using the class_name syntax, this will return an empty string.
func (Instance) GetFileScriptClassName ¶
Returns the name of the script class defined in the file at index 'idx'. If the file doesn't define a script class using the class_name syntax, this will return an empty string.
func (Instance) GetFileType ¶
Returns the resource type of the file at index 'idx'. This returns a string such as "Resource" or "GDScript", not a file extension such as ".gd".
func (Instance) GetParent ¶
Returns the parent directory for this directory or null if called on a directory at res:// or user://.
func (Instance) GetSubdirCount ¶
Returns the number of subdirectories in this directory.
Source Files