EditorInterface

gdext.classes.EditorInterface
See theEditorInterface companion object
abstract class EditorInterface extends Object

Generated wrapper for Godot's EditorInterface, extends Object.

Attributes

Companion
object
Graph
Supertypes
class Object
class Object
trait Matchable
class Any

Members list

Value members

Concrete methods

final def addRootNode(node: Node): Unit

EditorInterface.add_root_node

EditorInterface.add_root_node

Attributes

final def closeScene(): Long

EditorInterface.close_scene

EditorInterface.close_scene

Attributes

final def editNode(node: Node): Unit

EditorInterface.edit_node

EditorInterface.edit_node

Attributes

final def editResource(resource: Resource): Unit

EditorInterface.edit_resource

EditorInterface.edit_resource

Attributes

final def editScript(script: Script, line: Long, column: Long, grab_focus: Boolean): Unit

EditorInterface.edit_script

EditorInterface.edit_script

Attributes

final def getBaseControl(): Control

EditorInterface.get_base_control

EditorInterface.get_base_control

Attributes

EditorInterface.get_command_palette

EditorInterface.get_command_palette

Attributes

final def getCurrentDirectory(): String

EditorInterface.get_current_directory

EditorInterface.get_current_directory

Attributes

final def getCurrentFeatureProfile(): String

EditorInterface.get_current_feature_profile

EditorInterface.get_current_feature_profile

Attributes

final def getCurrentPath(): String

EditorInterface.get_current_path

EditorInterface.get_current_path

Attributes

final def getEditedSceneRoot(): Node

EditorInterface.get_edited_scene_root

EditorInterface.get_edited_scene_root

Attributes

final def getEditorLanguage(): String

EditorInterface.get_editor_language

EditorInterface.get_editor_language

Attributes

EditorInterface.get_editor_main_screen

EditorInterface.get_editor_main_screen

Attributes

EditorInterface.get_editor_paths

EditorInterface.get_editor_paths

Attributes

final def getEditorScale(): Double

EditorInterface.get_editor_scale

EditorInterface.get_editor_scale

Attributes

EditorInterface.get_editor_settings. Returns an owned reference: release it with unref() or inside Gd.scoped.

EditorInterface.get_editor_settings. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

final def getEditorTheme(): Theme

EditorInterface.get_editor_theme. Returns an owned reference: release it with unref() or inside Gd.scoped.

EditorInterface.get_editor_theme. Returns an owned reference: release it with unref() or inside Gd.scoped.

Attributes

EditorInterface.get_editor_toaster

EditorInterface.get_editor_toaster

Attributes

EditorInterface.get_editor_undo_redo

EditorInterface.get_editor_undo_redo

Attributes

EditorInterface.get_editor_viewport_2d

EditorInterface.get_editor_viewport_2d

Attributes

final def getEditorViewport3d(idx: Long): SubViewport

EditorInterface.get_editor_viewport_3d

EditorInterface.get_editor_viewport_3d

Attributes

EditorInterface.get_file_system_dock

EditorInterface.get_file_system_dock

Attributes

EditorInterface.get_inspector

EditorInterface.get_inspector

Attributes

final def getNode3dRotateSnap(): Double

EditorInterface.get_node_3d_rotate_snap

EditorInterface.get_node_3d_rotate_snap

Attributes

final def getNode3dScaleSnap(): Double

EditorInterface.get_node_3d_scale_snap

EditorInterface.get_node_3d_scale_snap

Attributes

final def getNode3dTranslateSnap(): Double

EditorInterface.get_node_3d_translate_snap

EditorInterface.get_node_3d_translate_snap

Attributes

final def getPlayingScene(): String

EditorInterface.get_playing_scene

EditorInterface.get_playing_scene

Attributes

EditorInterface.get_resource_filesystem

EditorInterface.get_resource_filesystem

Attributes

EditorInterface.get_resource_previewer

EditorInterface.get_resource_previewer

Attributes

EditorInterface.get_script_editor

EditorInterface.get_script_editor

Attributes

EditorInterface.get_selection

EditorInterface.get_selection

Attributes

override def godotClassName: String

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

The Godot class name for this instance. Engine wrappers override with the baked literal; user classes fall back to their Scala simple name (which is how registration names them).

Attributes

Definition Classes
final def inspectObject(`object`: Object, for_property: String, inspector_only: Boolean): Unit

EditorInterface.inspect_object

EditorInterface.inspect_object

Attributes

final def isDistractionFreeModeEnabled(): Boolean

EditorInterface.is_distraction_free_mode_enabled

EditorInterface.is_distraction_free_mode_enabled

Attributes

final def isMovieMakerEnabled(): Boolean

EditorInterface.is_movie_maker_enabled

EditorInterface.is_movie_maker_enabled

Attributes

final def isMultiWindowEnabled(): Boolean

EditorInterface.is_multi_window_enabled

EditorInterface.is_multi_window_enabled

Attributes

final def isNode3dSnapEnabled(): Boolean

EditorInterface.is_node_3d_snap_enabled

EditorInterface.is_node_3d_snap_enabled

Attributes

final def isObjectEdited(`object`: Object): Boolean

EditorInterface.is_object_edited

EditorInterface.is_object_edited

Attributes

final def isPlayingScene(): Boolean

EditorInterface.is_playing_scene

EditorInterface.is_playing_scene

Attributes

final def isPluginEnabled(plugin: String): Boolean

EditorInterface.is_plugin_enabled

EditorInterface.is_plugin_enabled

Attributes

final def markSceneAsUnsaved(): Unit

EditorInterface.mark_scene_as_unsaved

EditorInterface.mark_scene_as_unsaved

Attributes

final def openSceneFromPath(scene_filepath: String, set_inherited: Boolean): Unit

EditorInterface.open_scene_from_path

EditorInterface.open_scene_from_path

Attributes

final def playCurrentScene(): Unit

EditorInterface.play_current_scene

EditorInterface.play_current_scene

Attributes

final def playCustomScene(scene_filepath: String): Unit

EditorInterface.play_custom_scene

EditorInterface.play_custom_scene

Attributes

final def playMainScene(): Unit

EditorInterface.play_main_scene

EditorInterface.play_main_scene

Attributes

final def popupDialog(dialog: Window, rect: Rect2i): Unit

EditorInterface.popup_dialog

EditorInterface.popup_dialog

Attributes

final def popupDialogCentered(dialog: Window, minsize: Vector2i): Unit

EditorInterface.popup_dialog_centered

EditorInterface.popup_dialog_centered

Attributes

final def popupDialogCenteredClamped(dialog: Window, minsize: Vector2i, fallback_ratio: Double): Unit

EditorInterface.popup_dialog_centered_clamped

EditorInterface.popup_dialog_centered_clamped

Attributes

final def popupDialogCenteredRatio(dialog: Window, ratio: Double): Unit

EditorInterface.popup_dialog_centered_ratio

EditorInterface.popup_dialog_centered_ratio

Attributes

final def reloadSceneFromPath(scene_filepath: String): Unit

EditorInterface.reload_scene_from_path

EditorInterface.reload_scene_from_path

Attributes

final def restartEditor(save: Boolean): Unit

EditorInterface.restart_editor

EditorInterface.restart_editor

Attributes

final def saveAllScenes(): Unit

EditorInterface.save_all_scenes

EditorInterface.save_all_scenes

Attributes

final def saveScene(): Long

EditorInterface.save_scene

EditorInterface.save_scene

Attributes

final def saveSceneAs(path: String, with_preview: Boolean): Unit

EditorInterface.save_scene_as

EditorInterface.save_scene_as

Attributes

final def selectFile(file: String): Unit

EditorInterface.select_file

EditorInterface.select_file

Attributes

final def setCurrentFeatureProfile(profile_name: String): Unit

EditorInterface.set_current_feature_profile

EditorInterface.set_current_feature_profile

Attributes

final def setDistractionFreeMode(enter: Boolean): Unit

EditorInterface.set_distraction_free_mode

EditorInterface.set_distraction_free_mode

Attributes

final def setMainScreenEditor(name: String): Unit

EditorInterface.set_main_screen_editor

EditorInterface.set_main_screen_editor

Attributes

final def setMovieMakerEnabled(enabled: Boolean): Unit

EditorInterface.set_movie_maker_enabled

EditorInterface.set_movie_maker_enabled

Attributes

final def setObjectEdited(`object`: Object, edited: Boolean): Unit

EditorInterface.set_object_edited

EditorInterface.set_object_edited

Attributes

final def setPluginEnabled(plugin: String, enabled: Boolean): Unit

EditorInterface.set_plugin_enabled

EditorInterface.set_plugin_enabled

Attributes

final def stopPlayingScene(): Unit

EditorInterface.stop_playing_scene

EditorInterface.stop_playing_scene

Attributes

Inherited methods

def _can_handle(obj: GodotObject): Boolean

EditorInspectorPlugin: can this plugin handle obj's inspector?

EditorInspectorPlugin: can this plugin handle obj's inspector?

Attributes

Inherited from:
GodotScriptClass
def _enter_tree(): Unit

EditorPlugin/Node: entered the (editor) tree.

EditorPlugin/Node: entered the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _exit_tree(): Unit

EditorPlugin/Node: leaving the (editor) tree.

EditorPlugin/Node: leaving the (editor) tree.

Attributes

Inherited from:
GodotScriptClass
def _input(event: InputEvent): Unit

Called for every unhandled-or-not input event (Node._input).

Called for every unhandled-or-not input event (Node._input).

Attributes

Inherited from:
GodotScriptClass
def _parse_property(obj: GodotObject, varType: Long, name: String, hintType: Long, hintString: String, usage: Long, wide: Boolean): Boolean

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

EditorInspectorPlugin: inspect one property. Return true to take it over (after calling addPropertyEditor), false to let the default editor render.

Attributes

Inherited from:
GodotScriptClass
def _physics_process(delta: Double): Unit

Called every physics frame; delta is the fixed physics step.

Called every physics frame; delta is the fixed physics step.

Attributes

Inherited from:
GodotScriptClass
def _process(delta: Double): Unit

Called every rendered frame; delta is seconds since the last frame.

Called every rendered frame; delta is seconds since the last frame.

Attributes

Inherited from:
GodotScriptClass
def _ready(): Unit

Called when the node enters the scene tree and is ready.

Called when the node enters the scene tree and is ready.

Attributes

Inherited from:
GodotScriptClass
def _shortcut_input(event: InputEvent): Unit

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Called for shortcut input before _unhandled_input (Node._shortcut_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_input(event: InputEvent): Unit

Called for input not consumed by the UI (Node._unhandled_input).

Called for input not consumed by the UI (Node._unhandled_input).

Attributes

Inherited from:
GodotScriptClass
def _unhandled_key_input(event: InputEvent): Unit

Called for unhandled key input (Node._unhandled_key_input).

Called for unhandled key input (Node._unhandled_key_input).

Attributes

Inherited from:
GodotScriptClass
def _update_property(): Unit

EditorProperty: refresh the widget from the edited property's value.

EditorProperty: refresh the widget from the edited property's value.

Attributes

Inherited from:
GodotScriptClass
final def canTranslateMessages(): Boolean

Object.can_translate_messages

Object.can_translate_messages

Attributes

Inherited from:
Object
final def cancelFree(): Unit

Object.cancel_free

Object.cancel_free

Attributes

Inherited from:
Object
def cast[U <: GodotScriptClass](using meta: ClassMeta[U]): U

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Cast to a (super- or sub-) class U. Returns null if the object is not actually a U. Uses object_cast_to with U's class tag — a real engine type check, not a Scala cast.

Attributes

Inherited from:
GodotScriptClass
def free(): Unit

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Free a manually-managed object via object_destroy. No-op for reference-counted objects — use unref for those. The wrapper is dead afterwards: calling an engine method on it throws.

Attributes

Inherited from:
GodotScriptClass
final def getInstanceId(): Long

Object.get_instance_id

Object.get_instance_id

Attributes

Inherited from:
Object
final def getMethodArgumentCount(method: StringName): Long

Object.get_method_argument_count

Object.get_method_argument_count

Attributes

Inherited from:
Object

Object.get_translation_domain

Object.get_translation_domain

Attributes

Inherited from:
Object
final def hasConnections(signal: StringName): Boolean

Object.has_connections

Object.has_connections

Attributes

Inherited from:
Object
final def hasMeta(name: StringName): Boolean

Object.has_meta

Object.has_meta

Attributes

Inherited from:
Object
final def hasMethod(method: StringName): Boolean

Object.has_method

Object.has_method

Attributes

Inherited from:
Object
final def hasSignal(signal: StringName): Boolean

Object.has_signal

Object.has_signal

Attributes

Inherited from:
Object
final def hasUserSignal(signal: StringName): Boolean

Object.has_user_signal

Object.has_user_signal

Attributes

Inherited from:
Object
final def hostObject: GodotObject

The engine-side object handle for this instance.

The engine-side object handle for this instance.

Attributes

Inherited from:
GodotScriptClass
final def instanceId: InstanceId

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

This object's stable Godot InstanceId (the null sentinel if unbound). Mirrors Object.get_instance_id, but typed — pass it to APIs that key off a node's identity.

Attributes

Inherited from:
GodotScriptClass
final def isBlockingSignals(): Boolean

Object.is_blocking_signals

Object.is_blocking_signals

Attributes

Inherited from:
Object
final def isClass(`class`: String): Boolean

Object.is_class

Object.is_class

Attributes

Inherited from:
Object
final def isQueuedForDeletion(): Boolean

Object.is_queued_for_deletion

Object.is_queued_for_deletion

Attributes

Inherited from:
Object
final def isRefCounted: Boolean

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

True if this object is reference-counted (RefCounted subtree, e.g. a Resource) vs manually-managed (Object/Node subtree). Drives the lifetime methods below.

Attributes

Inherited from:
GodotScriptClass
def keep(): this.type

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Keep a reference adopted inside Gd.scoped past the end of the block: the caller now owns it and releases it with unref. Returns this.

Attributes

Inherited from:
GodotScriptClass
final def notification(what: Long, reversed: Boolean): Unit

Object.notification

Object.notification

Attributes

Inherited from:
Object
final def notifyPropertyListChanged(): Unit

Object.notify_property_list_changed

Object.notify_property_list_changed

Attributes

Inherited from:
Object
final def propertyCanRevert(property: StringName): Boolean

Object.property_can_revert

Object.property_can_revert

Attributes

Inherited from:
Object
def refInc(): this.type

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Take one more reference on a reference-counted object, owned by this wrapper until a matching unref. No-op for manually-managed objects (nodes). Returns this. (Named refInc rather than reference to avoid clashing with the generated RefCounted.reference(): Boolean method.)

Attributes

Inherited from:
GodotScriptClass
final def removeMeta(name: StringName): Unit

Object.remove_meta

Object.remove_meta

Attributes

Inherited from:
Object
final def removeUserSignal(signal: StringName): Unit

Object.remove_user_signal

Object.remove_user_signal

Attributes

Inherited from:
Object
final def setBlockSignals(enable: Boolean): Unit

Object.set_block_signals

Object.set_block_signals

Attributes

Inherited from:
Object
final def setMessageTranslation(enable: Boolean): Unit

Object.set_message_translation

Object.set_message_translation

Attributes

Inherited from:
Object
final def setTranslationDomain(domain: StringName): Unit

Object.set_translation_domain

Object.set_translation_domain

Attributes

Inherited from:
Object
final def tr(message: StringName, context: StringName): String

Object.tr

Object.tr

Attributes

Inherited from:
Object
final def trN(message: StringName, plural_message: StringName, n: Long, context: StringName): String

Object.tr_n

Object.tr_n

Attributes

Inherited from:
Object
def unref(): Unit

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Release one reference this wrapper owns (an engine Ref<T> return, Gd.create, or refInc), destroying the object if it was the last reference. Does nothing when the wrapper owns no reference, so a borrowed object can never be freed from under the engine.

Attributes

Inherited from:
GodotScriptClass
final def withHost(o: GDExtensionObjectPtr): this.type

Set the handle and return this (fluent, for wrapping fetched objects).

Set the handle and return this (fluent, for wrapping fetched objects).

Attributes

Inherited from:
GodotScriptClass