Struct gdnative::EditorPlugin

pub struct EditorPlugin { /* fields omitted */ }

tools class EditorPlugin : Node (manually managed)

Base class

EditorPlugin inherits Node and all of its methods.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine. In the cases where Rust code owns an object of this type, ownership should be either passed to the engine or the object must be manually destroyed using EditorPlugin::free.

Tool

This class is used to interact with godot's editor.

Methods

impl EditorPlugin

pub fn as_node(&self) -> Node

Up-cast.

pub fn new() -> Self

Constructor.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed. Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using EditorPlugin::free.

pub unsafe fn free(self)

Manually deallocate the object.

pub fn forward_canvas_gui_input(&mut self, event: Option<InputEvent>) -> bool

pub fn forward_draw_over_viewport(&mut self, overlay: Option<Control>)

pub fn forward_force_draw_over_viewport(&mut self, overlay: Option<Control>)

pub fn forward_spatial_gui_input(
    &mut self,
    camera: Option<Camera>,
    event: Option<InputEvent>
) -> bool

pub fn create_spatial_gizmo(
    &mut self,
    for_spatial: Option<Spatial>
) -> Option<EditorSpatialGizmo>

pub fn get_plugin_name(&mut self) -> GodotString

pub fn get_plugin_icon(&mut self) -> Option<Object>

pub fn has_main_screen(&mut self) -> bool

pub fn make_visible(&mut self, visible: bool)

pub fn edit(&mut self, object: Option<Object>)

pub fn handles(&mut self, object: Option<Object>) -> bool

pub fn get_state(&mut self) -> Dictionary

pub fn set_state(&mut self, state: Dictionary)

pub fn clear(&mut self)

pub fn save_external_data(&mut self)

pub fn apply_changes(&mut self)

pub fn get_breakpoints(&mut self) -> StringArray

pub fn set_window_layout(&mut self, layout: Option<ConfigFile>)

pub fn get_window_layout(&mut self, layout: Option<ConfigFile>)

pub fn add_control_to_container(
    &mut self,
    container: i64,
    control: Option<Object>
)

pub fn add_control_to_bottom_panel(
    &mut self,
    control: Option<Object>,
    title: GodotString
) -> Option<ToolButton>

pub fn add_control_to_dock(&mut self, slot: i64, control: Option<Object>)

pub fn remove_control_from_docks(&mut self, control: Option<Object>)

pub fn remove_control_from_bottom_panel(&mut self, control: Option<Object>)

pub fn add_tool_submenu_item(
    &mut self,
    name: GodotString,
    submenu: Option<Object>
)

pub fn add_custom_type(
    &mut self,
    _type: GodotString,
    base: GodotString,
    script: Option<Script>,
    icon: Option<Texture>
)

pub fn remove_custom_type(&mut self, _type: GodotString)

pub fn update_overlays(&self) -> i64

pub fn make_bottom_panel_item_visible(&mut self, item: Option<Object>)

pub fn hide_bottom_panel(&mut self)

pub fn get_undo_redo(&mut self) -> Option<UndoRedo>

pub fn queue_save_layout(&self)

pub fn add_import_plugin(&mut self, importer: Option<EditorImportPlugin>)

pub fn remove_import_plugin(&mut self, importer: Option<EditorImportPlugin>)

pub fn add_scene_import_plugin(
    &mut self,
    scene_importer: Option<EditorSceneImporter>
)

pub fn remove_scene_import_plugin(
    &mut self,
    scene_importer: Option<EditorSceneImporter>
)

pub fn add_export_plugin(&mut self, exporter: Option<EditorExportPlugin>)

pub fn remove_export_plugin(&mut self, exporter: Option<EditorExportPlugin>)

pub fn set_input_event_forwarding_always_enabled(&mut self)

pub fn set_force_draw_over_forwarding_enabled(&mut self)

pub fn get_editor_interface(&mut self) -> Option<EditorInterface>

pub fn cast<T: GodotObject>(&self) -> Option<T>

Methods from Deref<Target = Node>

pub fn as_object(&self) -> Object

Up-cast.

pub fn _process(&mut self, delta: f64)

pub fn _physics_process(&mut self, delta: f64)

pub fn _enter_tree(&mut self)

pub fn _exit_tree(&mut self)

pub fn _ready(&mut self)

pub fn _input(&mut self, event: Option<InputEvent>)

pub fn _unhandled_input(&mut self, event: Option<InputEvent>)

pub fn _unhandled_key_input(&mut self, event: Option<InputEventKey>)

pub fn add_child_below_node(
    &mut self,
    node: Option<Object>,
    child_node: Option<Object>,
    legible_unique_name: bool
)

pub fn set_name(&mut self, name: GodotString)

pub fn get_name(&self) -> GodotString

pub fn add_child(&mut self, node: Option<Object>, legible_unique_name: bool)

pub fn remove_child(&mut self, node: Option<Object>)

pub fn get_child_count(&self) -> i64

pub fn get_children(&self) -> VariantArray

pub fn get_child(&self, idx: i64) -> Option<Node>

pub fn has_node(&self, path: NodePath) -> bool

pub fn get_node(&self, path: NodePath) -> Option<Node>

pub fn get_parent(&self) -> Option<Node>

pub fn find_node(
    &self,
    mask: GodotString,
    recursive: bool,
    owned: bool
) -> Option<Node>

pub fn has_node_and_resource(&self, path: NodePath) -> bool

pub fn get_node_and_resource(&mut self, path: NodePath) -> VariantArray

pub fn is_inside_tree(&self) -> bool

pub fn is_a_parent_of(&self, node: Option<Object>) -> bool

pub fn is_greater_than(&self, node: Option<Object>) -> bool

pub fn get_path(&self) -> NodePath

pub fn get_path_to(&self, node: Option<Object>) -> NodePath

pub fn add_to_group(&mut self, group: GodotString, persistent: bool)

pub fn remove_from_group(&mut self, group: GodotString)

pub fn is_in_group(&self, group: GodotString) -> bool

pub fn move_child(&mut self, child_node: Option<Object>, to_position: i64)

pub fn get_groups(&self) -> VariantArray

pub fn raise(&mut self)

pub fn set_owner(&mut self, owner: Option<Object>)

pub fn get_owner(&self) -> Option<Node>

pub fn remove_and_skip(&mut self)

pub fn get_index(&self) -> i64

pub fn print_tree(&mut self)

pub fn set_filename(&mut self, filename: GodotString)

pub fn get_filename(&self) -> GodotString

pub fn propagate_notification(&mut self, what: i64)

pub fn propagate_call(
    &mut self,
    method: GodotString,
    args: VariantArray,
    parent_first: bool
)

pub fn set_physics_process(&mut self, enable: bool)

pub fn get_physics_process_delta_time(&self) -> f64

pub fn is_physics_processing(&self) -> bool

pub fn get_process_delta_time(&self) -> f64

pub fn set_process(&mut self, enable: bool)

pub fn is_processing(&self) -> bool

pub fn set_process_input(&mut self, enable: bool)

pub fn is_processing_input(&self) -> bool

pub fn set_process_unhandled_input(&mut self, enable: bool)

pub fn is_processing_unhandled_input(&self) -> bool

pub fn set_process_unhandled_key_input(&mut self, enable: bool)

pub fn is_processing_unhandled_key_input(&self) -> bool

pub fn set_pause_mode(&mut self, mode: i64)

pub fn can_process(&self) -> bool

pub fn print_stray_nodes(&mut self)

pub fn get_position_in_parent(&self) -> i64

pub fn set_display_folded(&mut self, fold: bool)

pub fn is_displayed_folded(&self) -> bool

pub fn set_process_internal(&mut self, enable: bool)

pub fn is_processing_internal(&self) -> bool

pub fn set_physics_process_internal(&mut self, enable: bool)

pub fn is_physics_processing_internal(&self) -> bool

pub fn get_tree(&self) -> Option<SceneTree>

pub fn duplicate(&self, flags: i64) -> Option<Node>

pub fn replace_by(&mut self, node: Option<Object>, keep_data: bool)

pub fn set_scene_instance_load_placeholder(&mut self, load_placeholder: bool)

pub fn get_scene_instance_load_placeholder(&self) -> bool

pub fn get_viewport(&self) -> Option<Viewport>

pub fn queue_free(&mut self)

pub fn request_ready(&mut self)

pub fn set_network_master(&mut self, id: i64, recursive: bool)

pub fn get_network_master(&self) -> i64

pub fn is_network_master(&self) -> bool

pub fn rpc_config(&mut self, method: GodotString, mode: i64)

pub fn rset_config(&mut self, property: GodotString, mode: i64)

pub fn _set_import_path(&mut self, import_path: NodePath)

pub fn _get_import_path(&self) -> NodePath

pub fn rpc(&mut self, method: GodotString, varargs: &[Variant]) -> Variant

pub fn rpc_unreliable(
    &mut self,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub fn rpc_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub fn rpc_unreliable_id(
    &mut self,
    peer_id: i64,
    method: GodotString,
    varargs: &[Variant]
) -> Variant

pub fn rset(&mut self, property: GodotString, value: Variant)

pub fn rset_id(&mut self, peer_id: i64, property: GodotString, value: Variant)

pub fn rset_unreliable(&mut self, property: GodotString, value: Variant)

pub fn rset_unreliable_id(
    &mut self,
    peer_id: i64,
    property: GodotString,
    value: Variant
)

pub fn cast<T: GodotObject>(&self) -> Option<T>

Trait Implementations

impl GodotObject for EditorPlugin

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut godot_object) -> Self

unsafe fn to_sys(&self) -> *mut godot_object

impl Deref for EditorPlugin

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl DerefMut for EditorPlugin

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.