EditorScript
Base script that can be used to add extension functions to the editor.
EditorScript.swift:20class EditorScriptScripts extending this class and implementing its _run method can be executed from the Script Editor’s File > Run menu option (or by pressing [kbd]Ctrl + Shift + X[/kbd]) while the editor is running. This is useful for adding custom in-editor functionality to Godot. For more complex additions, consider using EditorPlugins instead.
Example script:
Superclasses
class RefCountedBase class for reference-counted objects.
Citizens in SwiftGodot
Conformances
protocol CustomStringConvertibleA type with a customized textual representation.
protocol EquatableA type that can be compared for value equality.
protocol HashableA type that can be hashed into a
Hasherto produce an integer hash value.protocol Identifiable<ID>A class of types whose instances hold the value of an entity with stable identity.
protocol VariantRepresentableTypes that conform to VariantRepresentable can be stored directly in
Variantwith no conversion. These include all of the Variant types from Godot (for exampleGString,Rect,Plane), Godot objects (those that subclass SwiftGodot.Object) as well as the built-in Swift types UInt8, Int64 and Double.protocol VariantStorableTypes that conform to VariantStorable can be stored in a Variant and can be extracted back out of a Variant.
Type members
Instance members
func addRootNode(Node?) Adds
nodeas a child of the root node in the editor context.func getEditorInterface() -> EditorInterface? Returns the
EditorInterfacesingleton instance.func getScene() -> Node? Returns the Editor’s currently active scene.
Show implementation details (1)
Hide implementation details
func _run() This method is executed by the Editor when File > Run is used.