Struct EditorInterface
#[repr(C)]pub struct EditorInterface { /* private fields */ }
Expand description
Godot class EditorInterface.
Inherits Object
.
Related symbols:
editor_interface
: sidecar module with related enum/flag types
See also Godot docs for EditorInterface
.
§Singleton
This class is a singleton. You can get the one instance using EditorInterface::singleton()
.
§Final class
This class is final, meaning you cannot inherit from it, and it comes without I*
interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.
Implementations§
§impl EditorInterface
impl EditorInterface
pub fn singleton() -> Gd<EditorInterface>
pub fn restart_editor(&mut self)
pub fn restart_editor(&mut self)
To set the default parameters, use Self::restart_editor_ex
and its builder methods. See the book for detailed usage instructions.
pub fn restart_editor_ex<'a>(&'a mut self) -> ExRestartEditor<'a>
pub fn get_command_palette(&self) -> Option<Gd<EditorCommandPalette>>
pub fn get_resource_filesystem(&self) -> Option<Gd<EditorFileSystem>>
pub fn get_editor_paths(&self) -> Option<Gd<EditorPaths>>
pub fn get_resource_previewer(&self) -> Option<Gd<EditorResourcePreview>>
pub fn get_selection(&self) -> Option<Gd<EditorSelection>>
pub fn get_editor_settings(&self) -> Option<Gd<EditorSettings>>
pub fn get_editor_toaster(&self) -> Option<Gd<EditorToaster>>
pub fn get_editor_undo_redo(&self) -> Option<Gd<EditorUndoRedoManager>>
pub fn make_mesh_previews( &mut self, meshes: &Array<Gd<Mesh>>, preview_size: i32, ) -> Array<Gd<Texture2D>>
pub fn set_plugin_enabled(&mut self, plugin: impl AsArg<GString>, enabled: bool)
pub fn is_plugin_enabled(&self, plugin: impl AsArg<GString>) -> bool
pub fn get_editor_theme(&self) -> Option<Gd<Theme>>
pub fn get_base_control(&self) -> Option<Gd<Control>>
pub fn get_editor_main_screen(&self) -> Option<Gd<VBoxContainer>>
pub fn get_script_editor(&self) -> Option<Gd<ScriptEditor>>
pub fn get_editor_viewport_2d(&self) -> Option<Gd<SubViewport>>
pub fn get_editor_viewport_3d(&self) -> Option<Gd<SubViewport>>
pub fn get_editor_viewport_3d(&self) -> Option<Gd<SubViewport>>
To set the default parameters, use Self::get_editor_viewport_3d_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_editor_viewport_3d_ex<'a>(&'a self) -> ExGetEditorViewport3d<'a>
pub fn set_main_screen_editor(&mut self, name: impl AsArg<GString>)
pub fn set_distraction_free_mode(&mut self, enter: bool)
pub fn is_distraction_free_mode_enabled(&self) -> bool
pub fn is_multi_window_enabled(&self) -> bool
pub fn get_editor_scale(&self) -> f32
pub fn popup_dialog(&mut self, dialog: impl AsArg<Option<Gd<Window>>>)
pub fn popup_dialog(&mut self, dialog: impl AsArg<Option<Gd<Window>>>)
To set the default parameters, use Self::popup_dialog_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_dialog_ex<'a>( &'a mut self, dialog: impl AsArg<Option<Gd<Window>>> + 'a, ) -> ExPopupDialog<'a>
pub fn popup_dialog_centered(&mut self, dialog: impl AsArg<Option<Gd<Window>>>)
pub fn popup_dialog_centered(&mut self, dialog: impl AsArg<Option<Gd<Window>>>)
To set the default parameters, use Self::popup_dialog_centered_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_dialog_centered_ex<'a>( &'a mut self, dialog: impl AsArg<Option<Gd<Window>>> + 'a, ) -> ExPopupDialogCentered<'a>
pub fn popup_dialog_centered_ratio(
&mut self,
dialog: impl AsArg<Option<Gd<Window>>>,
)
pub fn popup_dialog_centered_ratio( &mut self, dialog: impl AsArg<Option<Gd<Window>>>, )
To set the default parameters, use Self::popup_dialog_centered_ratio_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_dialog_centered_ratio_ex<'a>( &'a mut self, dialog: impl AsArg<Option<Gd<Window>>> + 'a, ) -> ExPopupDialogCenteredRatio<'a>
pub fn popup_dialog_centered_clamped(
&mut self,
dialog: impl AsArg<Option<Gd<Window>>>,
)
pub fn popup_dialog_centered_clamped( &mut self, dialog: impl AsArg<Option<Gd<Window>>>, )
To set the default parameters, use Self::popup_dialog_centered_clamped_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_dialog_centered_clamped_ex<'a>( &'a mut self, dialog: impl AsArg<Option<Gd<Window>>> + 'a, ) -> ExPopupDialogCenteredClamped<'a>
pub fn get_current_feature_profile(&self) -> GString
pub fn set_current_feature_profile(&mut self, profile_name: impl AsArg<GString>)
pub fn popup_node_selector(&mut self, callback: &Callable)
pub fn popup_node_selector(&mut self, callback: &Callable)
To set the default parameters, use Self::popup_node_selector_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_node_selector_ex<'a>( &'a mut self, callback: &'a Callable, ) -> ExPopupNodeSelector<'a>
pub fn popup_property_selector(
&mut self,
object: impl AsArg<Option<Gd<Object>>>,
callback: &Callable,
)
pub fn popup_property_selector( &mut self, object: impl AsArg<Option<Gd<Object>>>, callback: &Callable, )
To set the default parameters, use Self::popup_property_selector_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_property_selector_ex<'a>( &'a mut self, object: impl AsArg<Option<Gd<Object>>> + 'a, callback: &'a Callable, ) -> ExPopupPropertySelector<'a>
pub fn popup_method_selector(
&mut self,
object: impl AsArg<Option<Gd<Object>>>,
callback: &Callable,
)
pub fn popup_method_selector( &mut self, object: impl AsArg<Option<Gd<Object>>>, callback: &Callable, )
To set the default parameters, use Self::popup_method_selector_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_method_selector_ex<'a>( &'a mut self, object: impl AsArg<Option<Gd<Object>>> + 'a, callback: &'a Callable, ) -> ExPopupMethodSelector<'a>
pub fn popup_quick_open(&mut self, callback: &Callable)
pub fn popup_quick_open(&mut self, callback: &Callable)
To set the default parameters, use Self::popup_quick_open_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_quick_open_ex<'a>( &'a mut self, callback: &'a Callable, ) -> ExPopupQuickOpen<'a>
pub fn popup_create_dialog(&mut self, callback: &Callable)
pub fn popup_create_dialog(&mut self, callback: &Callable)
To set the default parameters, use Self::popup_create_dialog_ex
and its builder methods. See the book for detailed usage instructions.
pub fn popup_create_dialog_ex<'a>( &'a mut self, callback: &'a Callable, ) -> ExPopupCreateDialog<'a>
pub fn get_file_system_dock(&self) -> Option<Gd<FileSystemDock>>
pub fn select_file(&mut self, file: impl AsArg<GString>)
pub fn get_selected_paths(&self) -> PackedArray<GString>
pub fn get_current_path(&self) -> GString
pub fn get_current_directory(&self) -> GString
pub fn get_inspector(&self) -> Option<Gd<EditorInspector>>
pub fn inspect_object(&mut self, object: impl AsArg<Option<Gd<Object>>>)
pub fn inspect_object(&mut self, object: impl AsArg<Option<Gd<Object>>>)
To set the default parameters, use Self::inspect_object_ex
and its builder methods. See the book for detailed usage instructions.
pub fn inspect_object_ex<'a>( &'a mut self, object: impl AsArg<Option<Gd<Object>>> + 'a, ) -> ExInspectObject<'a>
pub fn edit_resource(&mut self, resource: impl AsArg<Option<Gd<Resource>>>)
pub fn edit_node(&mut self, node: impl AsArg<Option<Gd<Node>>>)
pub fn edit_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn edit_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
To set the default parameters, use Self::edit_script_ex
and its builder methods. See the book for detailed usage instructions.
pub fn edit_script_ex<'a>( &'a mut self, script: impl AsArg<Option<Gd<Script>>> + 'a, ) -> ExEditScript<'a>
pub fn open_scene_from_path(&mut self, scene_filepath: impl AsArg<GString>)
pub fn open_scene_from_path(&mut self, scene_filepath: impl AsArg<GString>)
To set the default parameters, use Self::open_scene_from_path_ex
and its builder methods. See the book for detailed usage instructions.
pub fn open_scene_from_path_ex<'a>( &'a mut self, scene_filepath: impl AsArg<GString> + 'a, ) -> ExOpenSceneFromPath<'a>
pub fn reload_scene_from_path(&mut self, scene_filepath: impl AsArg<GString>)
pub fn get_open_scenes(&self) -> PackedArray<GString>
pub fn get_edited_scene_root(&self) -> Option<Gd<Node>>
pub fn save_scene(&mut self) -> Error
pub fn save_scene_as(&mut self, path: impl AsArg<GString>)
pub fn save_scene_as(&mut self, path: impl AsArg<GString>)
To set the default parameters, use Self::save_scene_as_ex
and its builder methods. See the book for detailed usage instructions.
pub fn save_scene_as_ex<'a>( &'a mut self, path: impl AsArg<GString> + 'a, ) -> ExSaveSceneAs<'a>
pub fn save_all_scenes(&mut self)
pub fn mark_scene_as_unsaved(&mut self)
pub fn play_main_scene(&mut self)
pub fn play_current_scene(&mut self)
pub fn play_custom_scene(&mut self, scene_filepath: impl AsArg<GString>)
pub fn stop_playing_scene(&mut self)
pub fn is_playing_scene(&self) -> bool
pub fn get_playing_scene(&self) -> GString
pub fn set_movie_maker_enabled(&mut self, enabled: bool)
pub fn is_movie_maker_enabled(&self) -> bool
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<NodePath>) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
To set the default parameters, use Self::get_meta_ex
and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>( &'a self, name: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
To set the default parameters, use Self::add_user_signal_ex
and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<StringName>, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant
.
It can detect call failures and will return Err
in such a case.
pub fn set_deferred( &mut self, property: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<StringName>) -> GString
To set the default parameters, use Self::tr_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<StringName>, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex
and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification()
, and depending on the notification, also to Godot’s lifecycle callbacks such as ready()
.
Starts from the highest ancestor (the Object
class) and goes down the hierarchy.
See also Godot docs for Object::notification()
.
§Panics
If you call this method on a user-defined object while holding a GdRef
or GdMut
guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification()
acquires a GdMut
lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify()
, but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.
Trait Implementations§
§impl Bounds for EditorInterface
impl Bounds for EditorInterface
§impl Debug for EditorInterface
impl Debug for EditorInterface
§impl Deref for EditorInterface
impl Deref for EditorInterface
§impl DerefMut for EditorInterface
impl DerefMut for EditorInterface
§fn deref_mut(&mut self) -> &mut <EditorInterface as Deref>::Target
fn deref_mut(&mut self) -> &mut <EditorInterface as Deref>::Target
§impl GodotClass for EditorInterface
impl GodotClass for EditorInterface
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Editor
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Editor
§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for EditorInterface
impl Inherits<Object> for EditorInterface
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for EditorInterface
impl WithSignals for EditorInterface
§type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
Auto Trait Implementations§
impl Freeze for EditorInterface
impl RefUnwindSafe for EditorInterface
impl !Send for EditorInterface
impl !Sync for EditorInterface
impl Unpin for EditorInterface
impl UnwindSafe for EditorInterface
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more