How do I target an object (In this case, a gridmap) in Godot using GDScript?
- User
How do I target an object (In this case, a gridmap) in Godot using GDScript?
Assistant
There are several ways to target/reference a GridMap (or any object) in Godot using GDScript:
Using Node Paths
The most common method is using
get_node()or the shorthand$:# Absolute path from root var gridmap = get_node("/root/Main/GridMap") # Relative path from current node var gridmap = get_node("GridMap") # or using shorthand var gridmap = $GridMap # Going up the tree var gridmap = get_node("../GridMap")Using @onready Variables
For nodes that exist in the scene when it loads:
@onready var gridmap = $GridMap # or @onready var gridmap = get_node("GridMap")Using find_child()
To search recursively through children:
var gridmap = find_child("GridMap", true, false)Using Groups
First, add your GridMap to a group (in the Inspector or via code), then:
# Get all nodes in a group var gridmaps = get_tree().get_nodes_in_group("gridmaps") var gridmap = gridmaps[0] if gridmaps.size() > 0 else null # Or get the first one var gridmap = get_tree().get_first_node_in_group("gridmaps")Using Node Type
To find nodes by their class type:
# Find all GridMap nodes in the scene for node in get_tree().get_nodes_in_group(""): if node is GridMap: var gridmap = node breakDirect Reference
You can also expose a variable in the Inspector:
@export var gridmap: GridMap # Then drag and drop the GridMap node in the InspectorOnce you have the reference, you can interact with the GridMap:
# Example usage gridmap.set_cell_item(Vector3i(0, 0, 0), 1) var cell_item = gridmap.get_cell_item(Vector3i(0, 0, 0))Choose the method that best fits your scene structure and use case. The
@onreadyapproach with node paths is often the most straightforward for nodes that exist in your scene at startup.- User
Function "get_node()" not found in base self.
Assistant
This error means you're trying to call
get_node()from a context where it's not available.get_node()is a method of the Node class, so your script needs to extend from Node (or one of its subclasses) to use it.Here are the common scenarios and solutions:
1. Make sure your script extends Node
Your script should extend from Node or one of its subclasses:
extends Node # or extends Node3D # or extends Control # etc. func _ready(): var gridmap = get_node("GridMap")2. If calling from a non-Node class
If your script extends Resource, RefCounted, or another non-Node class, you need to get a reference to a node first:
extends Resource func get_gridmap_from_node(node: Node): # Now use the node parameter to call get_node var gridmap = node.get_node("GridMap") return gridmap3. If calling from a static function
Static functions don't have access to instance methods:
extends Node # This won't work static func get_gridmap(): var gridmap = get_node("GridMap") # ERROR! # Do this instead func get_gridmap(): var gridmap = get_node("GridMap") # Works!4. Getting nodes from anywhere
If you need to access a node from anywhere in your project, you can:
# Use the scene tree (if you have access to any node) func get_gridmap_from_tree(any_node: Node): var root = any_node.get_tree().root var gridmap = root.get_node("Main/GridMap") # Adjust path as needed # Or use autoload/singleton pattern # Create an autoload script that holds references to important nodes5. Common pattern for GridMap access
Here's a typical setup:
extends Node3D # Or whatever node type your script is attached to @onready var gridmap = $GridMap # Assumes GridMap is a child func _ready(): if gridmap: gridmap.set_cell_item(Vector3i(0, 0, 0), 1)What type of class does your script extend from? This will help me give you a more specific solution.
- User
I'm using [extends EditorScript]. My issue is that by doing this, I've lost self data. The code should work whether called from editor or from game, (extends GridMap in game), there's a _ready function and a _run function, both of which immediately call a Main function. The _ready function calls Main(self). I need the _run function to supply the same data via a Main({SOMEHOW POINT TO SELF NODE}) call.
Assistant
Ah, I see! You're creating a script that can work both as an EditorScript (run from the editor) and as a regular GridMap script (run in game). The challenge is that EditorScript doesn't extend Node, so you need to find the GridMap node differently.
Here's how to get the GridMap reference in your
_run()function:extends EditorScript func _run(): # Get the currently selected node in the editor var selection = get_editor_interface().get_selection() var selected_nodes = selection.get_selected_nodes() if selected_nodes.size() > 0: var node = selected_nodes[0] if node is GridMap: Main(node) else: push_error("Selected node is not a GridMap") else: push_error("No node selected") func Main(gridmap_node: GridMap): # Your main logic here print("Working with GridMap: ", gridmap_node.name) # gridmap_node.set_cell_item(Vector3i(0, 0, 0), 1) # exampleOr, if you want it to work more flexibly with a dual-purpose script:
# This script can extend either EditorScript OR GridMap # Use conditional compilation or separate files # For the EditorScript version: extends EditorScript func _run(): var interface = get_editor_interface() var selection = interface.get_selection() var selected_nodes = selection.get_selected_nodes() for node in selected_nodes: if node is GridMap: Main(node) return # If no GridMap selected, try to find one in the edited scene var edited_scene = interface.get_edited_scene_root() if edited_scene: var gridmap = find_gridmap_in_tree(edited_scene) if gridmap: Main(gridmap) else: push_error("No GridMap found in scene") func find_gridmap_in_tree(node: Node) -> GridMap: if node is GridMap: return node for child in node.get_children(): var result = find_gridmap_in_tree(child) if result: return result return null func Main(gridmap_node: GridMap): # Your actual logic here passFor a cleaner dual-purpose setup, you might consider:
# Determine context and extend appropriately @tool extends EditorScript if Engine.is_editor_hint() else GridMap func _ready(): if not Engine.is_editor_hint(): Main(self) func _run(): if Engine.is_editor_hint(): # Editor context - find the GridMap var gridmap = get_gridmap_from_editor() if gridmap: Main(gridmap) func get_gridmap_from_editor() -> GridMap: var interface = get_editor_interface() var selection = interface.get_selection() var selected = selection.get_selected_nodes() if selected.size() > 0 and selected[0] is GridMap: return selected[0] return null func Main(gridmap_node: GridMap): # Your shared logic here print("Processing GridMap: ", gridmap_node.name)Note: The conditional extends syntax I showed above is pseudocode. In practice, you'd typically use one of these approaches:
- Two separate scripts - one for EditorScript and one for GridMap, both calling a shared function
- Tool script - Use
@tool extends GridMapand checkEngine.is_editor_hint() - EditorScript only - Always use EditorScript and find the GridMap node through the editor interface
The most practical approach is often to use option 1 or 2, depending on your specific needs.
- User
For some reason you're trying to use the selected node as the self node. The self node should, in this case, be the attached gridmap object, regardless of which node is selected.
Assistant
Ah, I understand now! You want to find the GridMap node that this script is attached to, not the selected node. Since EditorScript doesn't have a node context, you need to find which GridMap in the scene has this script attached.
Here's how to find the GridMap that has your script attached:
extends EditorScript func _run(): var interface = get_editor_interface() var edited_scene = interface.get_edited_scene_root() if edited_scene: var gridmap = find_gridmap_with_script(edited_scene) if gridmap: Main(gridmap) else: push_error("Could not find GridMap with this script attached") func find_gridmap_with_script(node: Node) -> GridMap: # Check if this node is a GridMap with our script if node is GridMap: var script_path = get_script().resource_path if node.get_script() and node.get_script().resource_path == script_path: return node # Recursively check children for child in node.get_children(): var result = find_gridmap_with_script(child) if result: return result return null func Main(gridmap_node: GridMap): # Your main logic here print("Working with GridMap: ", gridmap_node.name)Or, more concisely:
extends EditorScript func _run(): var gridmap = get_self_gridmap() if gridmap: Main(gridmap) func get_self_gridmap() -> GridMap: var root = get_editor_interface().get_edited_scene_root() var script_path = get_script().resource_path # Find all GridMap nodes var gridmaps = [] _find_all_gridmaps(root, gridmaps) # Find the one with this script attached for gm in gridmaps: if gm.get_script() and gm.get_script().resource_path == script_path: return gm return null func _find_all_gridmaps(node: Node, list: Array): if node is GridMap: list.append(node) for child in node.get_children(): _find_all_gridmaps(child, list) func Main(gridmap_node: GridMap): # Your shared logic passThis way, whether called from
_ready()(as GridMap withself) or_run()(as EditorScript finding itself), the Main function receives the same GridMap node reference.
Other models, same or similar prompt
Responses were produced in different, uncontrolled contexts (system prompts, settings, prior turns). This is not a benchmark.