Struct gdnative::EditorPlugin

pub struct EditorPlugin { /* fields omitted */ }

tools class EditorPlugin inherits Node (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Class hierarchy

EditorPlugin inherits methods from:

• Node
• Object

Tool

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

Methods

impl EditorPlugin

Constants

pub const CONTAINER_PROJECT_SETTING_TAB_LEFT: i64

pub const DOCK_SLOT_LEFT_UR: i64

pub const CONTAINER_CANVAS_EDITOR_SIDE_LEFT: i64

pub const DOCK_SLOT_LEFT_BL: i64

pub const DOCK_SLOT_RIGHT_BL: i64

pub const DOCK_SLOT_RIGHT_UL: i64

pub const DOCK_SLOT_MAX: i64

pub const DOCK_SLOT_RIGHT_UR: i64

pub const CONTAINER_CANVAS_EDITOR_BOTTOM: i64

pub const CONTAINER_PROJECT_SETTING_TAB_RIGHT: i64

pub const CONTAINER_CANVAS_EDITOR_SIDE_RIGHT: i64

pub const DOCK_SLOT_LEFT_UL: i64

pub const CONTAINER_SPATIAL_EDITOR_SIDE_RIGHT: i64

pub const CONTAINER_SPATIAL_EDITOR_MENU: i64

pub const DOCK_SLOT_LEFT_BR: i64

pub const CONTAINER_SPATIAL_EDITOR_BOTTOM: i64

pub const DOCK_SLOT_RIGHT_BR: i64

pub const CONTAINER_CANVAS_EDITOR_MENU: i64

pub const CONTAINER_PROPERTY_EDITOR_BOTTOM: i64

pub const CONTAINER_TOOLBAR: i64

pub const CONTAINER_SPATIAL_EDITOR_SIDE_LEFT: i64

impl EditorPlugin

pub unsafe fn add_autoload_singleton(
    &mut self,
    name: GodotString,
    path: GodotString
)

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

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

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

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

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

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

pub unsafe fn add_inspector_plugin(
    &mut self,
    plugin: Option<EditorInspectorPlugin>
)

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

pub unsafe fn add_spatial_gizmo_plugin(
    &mut self,
    plugin: Option<EditorSpatialGizmoPlugin>
)

pub unsafe fn add_tool_menu_item(
    &mut self,
    name: GodotString,
    handler: Option<Object>,
    callback: GodotString,
    ud: Variant
)

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

pub unsafe fn apply_changes(&mut self)

pub unsafe fn build(&mut self) -> bool

pub unsafe fn clear(&mut self)

pub unsafe fn disable_plugin(&mut self)

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

pub unsafe fn enable_plugin(&mut self)

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

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

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

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

pub unsafe fn get_breakpoints(&mut self) -> StringArray

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

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

pub unsafe fn get_plugin_name(&mut self) -> GodotString

pub unsafe fn get_script_create_dialog(&mut self) -> Option<ScriptCreateDialog>

pub unsafe fn get_state(&mut self) -> Dictionary

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

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

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

pub unsafe fn has_main_screen(&mut self) -> bool

pub unsafe fn hide_bottom_panel(&mut self)

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

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

pub unsafe fn queue_save_layout(&self)

pub unsafe fn remove_autoload_singleton(&mut self, name: GodotString)

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

pub unsafe fn remove_control_from_container(
    &mut self,
    container: i64,
    control: Option<Control>
)

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

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

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

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

pub unsafe fn remove_inspector_plugin(
    &mut self,
    plugin: Option<EditorInspectorPlugin>
)

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

pub unsafe fn remove_spatial_gizmo_plugin(
    &mut self,
    plugin: Option<EditorSpatialGizmoPlugin>
)

pub unsafe fn remove_tool_menu_item(&mut self, name: GodotString)

pub unsafe fn save_external_data(&mut self)

pub unsafe fn set_force_draw_over_forwarding_enabled(&mut self)

pub unsafe fn set_input_event_forwarding_always_enabled(&mut self)

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

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

pub unsafe fn update_overlays(&self) -> i64

pub unsafe fn to_node(&self) -> Node

Up-cast.

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Methods from Deref<Target = Node>

pub const NOTIFICATION_DRAG_BEGIN: i64

pub const NOTIFICATION_PAUSED: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_DRAG_END: i64

pub const NOTIFICATION_ENTER_TREE: i64

pub const NOTIFICATION_PHYSICS_PROCESS: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_MOVED_IN_PARENT: i64

pub const PAUSE_MODE_PROCESS: i64

pub const NOTIFICATION_EXIT_TREE: i64

pub const NOTIFICATION_PROCESS: i64

pub const NOTIFICATION_INSTANCED: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub const NOTIFICATION_UNPAUSED: i64

pub const DUPLICATE_SIGNALS: i64

pub const NOTIFICATION_UNPARENTED: i64

pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64

pub const NOTIFICATION_APP_PAUSED: i64

pub const PAUSE_MODE_INHERIT: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const NOTIFICATION_INTERNAL_PROCESS: i64

pub const DUPLICATE_USE_INSTANCING: i64

pub const DUPLICATE_SCRIPTS: i64

pub const DUPLICATE_GROUPS: i64

pub const NOTIFICATION_PARENTED: i64

pub const NOTIFICATION_PATH_CHANGED: i64

pub const NOTIFICATION_READY: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const PAUSE_MODE_STOP: i64

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub unsafe fn _enter_tree(&mut self)

pub unsafe fn _exit_tree(&mut self)

pub unsafe fn _get_configuration_warning(&mut self) -> GodotString

pub unsafe fn _get_editor_description(&self) -> GodotString

pub unsafe fn _get_import_path(&self) -> NodePath

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

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

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

pub unsafe fn _ready(&mut self)

pub unsafe fn _set_editor_description(
    &mut self,
    editor_description: GodotString
)

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

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

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

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

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

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

pub unsafe fn can_process(&self) -> bool

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

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

pub unsafe fn find_parent(&self, mask: GodotString) -> Option<Node>

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

pub unsafe fn get_child_count(&self) -> i64

pub unsafe fn get_children(&self) -> VariantArray

pub unsafe fn get_custom_multiplayer(&self) -> Option<MultiplayerAPI>

pub unsafe fn get_filename(&self) -> GodotString

pub unsafe fn get_groups(&self) -> VariantArray

pub unsafe fn get_index(&self) -> i64

pub unsafe fn get_multiplayer(&self) -> Option<MultiplayerAPI>

pub unsafe fn get_name(&self) -> GodotString

pub unsafe fn get_network_master(&self) -> i64

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

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

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

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

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

pub unsafe fn get_path(&self) -> NodePath

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

pub unsafe fn get_pause_mode(&self) -> NodePauseMode

pub unsafe fn get_physics_process_delta_time(&self) -> f64

pub unsafe fn get_position_in_parent(&self) -> i64

pub unsafe fn get_process_delta_time(&self) -> f64

pub unsafe fn get_process_priority(&self) -> i64

pub unsafe fn get_scene_instance_load_placeholder(&self) -> bool

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

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

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

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

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

pub unsafe fn is_displayed_folded(&self) -> bool

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

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

pub unsafe fn is_inside_tree(&self) -> bool

pub unsafe fn is_network_master(&self) -> bool

pub unsafe fn is_physics_processing(&self) -> bool

pub unsafe fn is_physics_processing_internal(&self) -> bool

pub unsafe fn is_processing(&self) -> bool

pub unsafe fn is_processing_input(&self) -> bool

pub unsafe fn is_processing_internal(&self) -> bool

pub unsafe fn is_processing_unhandled_input(&self) -> bool

pub unsafe fn is_processing_unhandled_key_input(&self) -> bool

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

pub unsafe fn print_stray_nodes(&mut self)

pub unsafe fn print_tree(&mut self)

pub unsafe fn print_tree_pretty(&mut self)

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

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

pub unsafe fn queue_free(&mut self)

pub unsafe fn raise(&mut self)

pub unsafe fn remove_and_skip(&mut self)

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

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

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

pub unsafe fn request_ready(&mut self)

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

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

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

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

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

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

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

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

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

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

pub unsafe fn set_custom_multiplayer(&mut self, api: Option<MultiplayerAPI>)

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

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

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

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

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

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

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

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

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

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

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

pub unsafe fn set_process_priority(&mut self, priority: i64)

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

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

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

pub unsafe fn update_configuration_warning(&mut self)

pub unsafe fn to_object(&self) -> Object

Up-cast.

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

Generic dynamic cast.

Trait Implementations

impl Clone for EditorPlugin

fn clone(&self) -> EditorPlugin

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for EditorPlugin

impl Debug for EditorPlugin

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for EditorPlugin

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl DerefMut for EditorPlugin

fn deref_mut(&mut self) -> &mut Node

Mutably dereferences the value.

impl FromVariant for EditorPlugin

fn from_variant(variant: &Variant) -> Result<EditorPlugin, FromVariantError>

impl GodotObject for EditorPlugin

fn class_name() -> &'static str

unsafe fn from_sys(obj: *mut c_void) -> EditorPlugin

unsafe fn from_return_position_sys(obj: *mut c_void) -> EditorPlugin

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

impl QueueFree for EditorPlugin

unsafe fn godot_queue_free(&mut self)

impl ToVariant for EditorPlugin

fn to_variant(&self) -> Variant