Index · Object → Node → EditorPlugin → GridMapEditorPlugin

GridMapEditorPlugin

Editor for GridMap nodes.

Class Description

GridMapEditorPlugin provides access to the GridMap editor functionality.

Properties

Inherited from Node (14)
var owner: Node

Methods

func clear_selection() -> void

Deselects any currently selected cells.

func get_current_grid_map() -> GridMap

Returns the GridMap node currently edited by the grid map editor.

func get_selected_cells() -> Array

Returns an array of Vector3is with the selected cells' coordinates.

func get_selected_palette_item() -> int

Returns the index of the selected MeshLibrary item in the grid map editor's palette or -1 if no item is selected.

Note: The indices might not be in the same order as they appear in the editor's interface.

func get_selection() -> AABB

Returns the cell coordinate bounds of the current selection. Use has_selection() to check if there is an active selection.

func has_selection() -> bool

Returns true if there are selected cells.

func set_selected_palette_item(item: int) -> void

Selects the MeshLibrary item with the given index in the grid map editor's palette. If a negative index is given, no item will be selected. If a value greater than the last index is given, the last item will be selected.

Note: The indices might not be in the same order as they appear in the editor's interface.

func set_selection(begin: Vector3i, end: Vector3i) -> void

Selects the cells inside the given bounds from begin to end.

Inherited from EditorPlugin (76)
func _apply_changes() -> void
func _build() -> bool
func _clear() -> void
func _disable_plugin() -> void
func _edit(object: Object) -> void
func _enable_plugin() -> void
func _forward_3d_draw_over_viewport(viewport_control: Control) -> void
func _forward_3d_force_draw_over_viewport(viewport_control: Control) -> void
func _forward_3d_gui_input(viewport_camera: Camera3D, event: InputEvent) -> int
func _forward_canvas_draw_over_viewport(viewport_control: Control) -> void
func _forward_canvas_force_draw_over_viewport(viewport_control: Control) -> void
func _get_unsaved_status(for_scene: String) -> String
func _get_window_layout(configuration: ConfigFile) -> void
func _handles(object: Object) -> bool
func _make_visible(visible: bool) -> void
func _save_external_data() -> void
func _set_state(state: Dictionary) -> void
func _set_window_layout(configuration: ConfigFile) -> void
func add_autoload_singleton(name: String, path: String) -> void
func add_control_to_bottom_panel(control: Control, title: String, shortcut: Shortcut = null) -> Button
func add_control_to_dock(slot: EditorPlugin.DockSlot, control: Control, shortcut: Shortcut = null) -> void
func add_custom_type(type: String, base: String, script: Script, icon: Texture2D) -> void
func add_dock(dock: EditorDock) -> void
func add_import_plugin(importer: EditorImportPlugin, first_priority: bool = false) -> void
func add_scene_format_importer_plugin(scene_format_importer: EditorSceneFormatImporter, first_priority: bool = false) -> void
func add_scene_post_import_plugin(scene_import_plugin: EditorScenePostImportPlugin, first_priority: bool = false) -> void
func add_tool_menu_item(name: String, callable: Callable) -> void
func add_tool_submenu_item(name: String, submenu: PopupMenu) -> void
func hide_bottom_panel() -> void
func queue_save_layout() -> void
func remove_autoload_singleton(name: String) -> void
func remove_control_from_docks(control: Control) -> void
func remove_custom_type(type: String) -> void
func remove_dock(dock: EditorDock) -> void
func remove_tool_menu_item(name: String) -> void
func set_dock_tab_icon(control: Control, icon: Texture2D) -> void
Inherited from Node (106)
func _enter_tree() -> void
func _exit_tree() -> void
func _input(event: InputEvent) -> void
func _physics_process(delta: float) -> void
func _process(delta: float) -> void
func _ready() -> void
func _shortcut_input(event: InputEvent) -> void
func _unhandled_input(event: InputEvent) -> void
func _unhandled_key_input(event: InputEvent) -> void
func add_child(node: Node, force_readable_name: bool = false, internal: Node.InternalMode = 0) -> void
func add_sibling(sibling: Node, force_readable_name: bool = false) -> void
func add_to_group(group: StringName, persistent: bool = false) -> void
func atr(message: String, context: StringName = "") -> String
func atr_n(message: String, plural_message: StringName, n: int, context: StringName = "") -> String
func can_process() -> bool
func duplicate(flags: int = 15) -> Node
func find_child(pattern: String, recursive: bool = true, owned: bool = true) -> Node
func find_children(pattern: String, type: String = "", recursive: bool = true, owned: bool = true) -> Node[]
func find_parent(pattern: String) -> Node
func get_child(idx: int, include_internal: bool = false) -> Node
func get_child_count(include_internal: bool = false) -> int
func get_children(include_internal: bool = false) -> Node[]
func get_groups() -> StringName[]
func get_index(include_internal: bool = false) -> int
func get_node(path: NodePath) -> Node
func get_orphan_node_ids() -> int[]
func get_parent() -> Node
func get_path() -> NodePath
func get_path_to(node: Node, use_unique_path: bool = false) -> NodePath
func get_window() -> Window
func has_node(path: NodePath) -> bool
func is_ancestor_of(node: Node) -> bool
func is_greater_than(node: Node) -> bool
func is_in_group(group: StringName) -> bool
func move_child(child_node: Node, to_index: int) -> void
func notify_deferred_thread_group(what: int) -> void
func notify_thread_safe(what: int) -> void
func print_orphan_nodes() -> void
func print_tree() -> void
func print_tree_pretty() -> void
func propagate_call(method: StringName, args: Array = [], parent_first: bool = false) -> void
func propagate_notification(what: int) -> void
func queue_free() -> void
func remove_child(node: Node) -> void
func remove_from_group(group: StringName) -> void
func reparent(new_parent: Node, keep_global_transform: bool = true) -> void
func replace_by(node: Node, keep_groups: bool = false) -> void
func request_ready() -> void
func rpc(method: StringName) -> Error
func rpc_config(method: StringName, config: Variant) -> void
func rpc_id(peer_id: int, method: StringName) -> Error
func set_deferred_thread_group(property: StringName, value: Variant) -> void
func set_display_folded(fold: bool) -> void
func set_editable_instance(node: Node, is_editable: bool) -> void
func set_multiplayer_authority(id: int, recursive: bool = true) -> void
func set_physics_process(enable: bool) -> void
func set_physics_process_internal(enable: bool) -> void
func set_process(enable: bool) -> void
func set_process_input(enable: bool) -> void
func set_process_internal(enable: bool) -> void
func set_process_shortcut_input(enable: bool) -> void
func set_process_unhandled_input(enable: bool) -> void
func set_scene_instance_load_placeholder(load_placeholder: bool) -> void
func set_thread_safe(property: StringName, value: Variant) -> void
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from EditorPlugin (6)
signal main_screen_changed(screen_name: String)
signal resource_saved(resource: Resource)
signal scene_changed(scene_root: Node)
signal scene_closed(filepath: String)
signal scene_saved(filepath: String)
Inherited from Node (11)
signal child_entered_tree(node: Node)
signal child_exiting_tree(node: Node)
signal ready()
signal renamed()
signal replacing_by(node: Node)
signal tree_entered()
signal tree_exited()
signal tree_exiting()
Inherited from Object (2)