Documentation
¶
Overview ¶
This object holds information of all resources in the filesystem, their types, etc.
Note: This class shouldn't be instantiated directly. Instead, access the singleton using EditorInterface.GetResourceFilesystem.
Index ¶
- type Advanced
- type Any
- type Extension
- type ID
- type Instance
- func (self Instance) AsEditorFileSystem() Instance
- func (self Instance) AsNode() Node.Instance
- func (self Instance) AsObject() [1]gd.Object
- func (self Instance) GetFileType(path string) string
- func (self Instance) GetFilesystem() EditorFileSystemDirectory.Instance
- func (self Instance) GetFilesystemPath(path string) EditorFileSystemDirectory.Instance
- func (self Instance) GetScanningProgress() Float.X
- func (self Instance) ID() ID
- func (self Instance) IsScanning() bool
- func (self Instance) OnFilesystemChanged(cb func(), flags ...Signal.Flags)
- func (self Instance) OnResourcesReimported(cb func(resources []string), flags ...Signal.Flags)
- func (self Instance) OnResourcesReimporting(cb func(resources []string), flags ...Signal.Flags)
- func (self Instance) OnResourcesReload(cb func(resources []string), flags ...Signal.Flags)
- func (self Instance) OnScriptClassesUpdated(cb func(), flags ...Signal.Flags)
- func (self Instance) OnSourcesChanged(cb func(exist bool), flags ...Signal.Flags)
- func (self Instance) ReimportFiles(files []string)
- func (self Instance) Scan()
- func (self Instance) ScanSources()
- func (self *Instance) SetObject(obj [1]gd.Object) bool
- func (self Instance) UpdateFile(path string)
- 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]) AsEditorFileSystem ¶
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.EditorFileSystem
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) AsEditorFileSystem ¶
func (Instance) GetFileType ¶
Returns the resource type of the file, given the full path. This returns a string such as "Resource" or "GDScript", not a file extension such as ".gd".
func (Instance) GetFilesystem ¶
func (self Instance) GetFilesystem() EditorFileSystemDirectory.Instance
Gets the root directory object.
func (Instance) GetFilesystemPath ¶
func (self Instance) GetFilesystemPath(path string) EditorFileSystemDirectory.Instance
Returns a view into the filesystem at 'path'.
func (Instance) GetScanningProgress ¶
Returns the scan progress for 0 to 1 if the FS is being scanned.
func (Instance) IsScanning ¶
Returns true if the filesystem is being scanned.
func (Instance) OnFilesystemChanged ¶
func (Instance) OnResourcesReimported ¶
func (Instance) OnResourcesReimporting ¶
func (Instance) OnResourcesReload ¶
func (Instance) OnScriptClassesUpdated ¶
func (Instance) OnSourcesChanged ¶
func (Instance) ReimportFiles ¶
Reimports a set of files. Call this if these files or their .import files were directly edited by script or an external program.
If the file type changed or the file was newly created, use UpdateFile or Scan.
Note: This function blocks until the import is finished. However, the main loop iteration, including timers and Node.Process, will occur during the import process due to progress bar updates. Avoid calls to ReimportFiles or Scan while an import is in progress.
func (Instance) ScanSources ¶
func (self Instance) ScanSources()
Check if the source of any imported resource changed.
func (Instance) UpdateFile ¶
Add a file in an existing directory, or schedule file information to be updated on editor restart. Can be used to update text files saved by an external program.
This will not import the file. To reimport, call ReimportFiles or Scan methods.
Source Files