Godot GDScript (4.x)
Write correct, statically typed GDScript and use the node lifecycle and signal
system the way the engine intends. Targets Godot 4.7 (GDScript 2.0).
When to use
- Use when writing or fixing
.gd files: declaring variables, functions, classes,
using @export/@onready, connecting signals, or awaiting coroutines/signals.
- Use when porting Godot 3.x scripts to 4.x and the script no longer parses.
When not to use: scene/node structure and instancing questions →
godot-nodes-scenes; signal architecture/decoupling patterns →
godot-signals-groups; using C# instead of GDScript → godot-csharp.
Core workflow
- Type everything you can. GDScript 2.0 supports static types
(
var hp: int = 10, func add(a: int, b: int) -> int:). Types catch errors at
parse time and speed up the VM. Use := for inferred types.
- Use the lifecycle callbacks for their purpose:
_ready() once when the node
and its children enter the tree; _process(delta) every rendered frame;
_physics_process(delta) on the fixed physics tick (use it for movement/physics).
- Grab node references with
@onready, not in _init() — children do not exist
until the node enters the tree.
- Expose tunables with
@export so designers edit them in the Inspector.
- React to events with signals +
await, not polling, where it reads cleanly.
- Run and read errors. The Debugger panel prints typed errors with line numbers;
fix the first error first (later ones are often cascades).
Patterns
1. A typed script with lifecycle, @export, and @onready
extends Node2D
class_name Spinner # registers a global type usable in other scripts
@export var speed: float = 90.0 # editable in the Inspector (degrees/sec)
@export_range(0, 10, 0.5) var wobble := 2.0
@onready var sprite: Sprite2D = $Sprite2D # resolved when the node enters the tree
func _ready() -> void:
# Runs once, after children are ready. Safe to touch $Sprite2D here.
sprite.modulate = Color.AQUA
func _process(delta: float) -> void:
# delta is seconds since last frame; multiply rates by it for FPS independence.
rotation_degrees += speed * delta
2. Signals: declare, emit, connect (4.x Callable syntax)
extends Node
signal health_changed(current: int, maximum: int) # typed signal params
var health := 100
func take_damage(amount: int) -> void:
health = maxi(health - amount, 0) # maxi/maxf are typed; max() returns Variant
health_changed.emit(health, 100) # 4.x: emit as a method on the signal
func _ready() -> void:
# 4.x: connect with a Callable, not a string method name.
health_changed.connect(_on_health_changed)
func _on_health_changed(current: int, maximum: int) -> void:
print("HP: %d/%d" % [current, maximum])
3. await — pause until a timer or signal fires (replaces 3.x yield)
func flash_then_continue() -> void:
modulate = Color.RED
await get_tree().create_timer(0.2).timeout # resume after 0.2s
modulate = Color.WHITE
# await any signal: var result = await some_node.some_signal
4. Lambdas, typed arrays, and safe access
var enemies: Array[Node] = [] # typed array
func cull_dead() -> void:
enemies = enemies.filter(func(e): return e.is_inside_tree())
func get_first_name(d: Dictionary) -> String:
return d.get("name", "unknown") # default avoids missing-key errors
Pitfalls
- 3.x → 4.x signal API changed.
emit_signal("x") still works but prefer
x.emit(...); connect("x", self, "_on_x") is gone — use x.connect(_on_x) with a
Callable. yield(obj, "sig") is now await obj.sig.
export var is now @export var (annotation). Likewise onready→@onready,
tool→@tool, remote/master RPC keywords → the @rpc(...) annotation.
@onready and $NodePath in _init() fail — the node isn't in the tree yet.
Initialize node references in _ready() or with @onready.
- Integer division truncates.
5 / 2 == 2. Use 5.0 / 2 or cast to float.
_process vs _physics_process. Put move_and_slide() and physics in
_physics_process(delta); using _process makes motion frame-rate dependent.
class_name must be unique project-wide and is required to use the type name in
other scripts or as an Inspector type.
- An override stops parsing after upgrading to 4.7 → since 4.7 an overriding method
inherits the parent's typed return, so every path must
return a value (add
return null at the end if needed). Also new in 4.7: setting one element of a packed
array property (points[0] = v) no longer calls that property's setter; reassign the
whole array if the setter must run.
References
- For the full annotation list, advanced typing, and style conventions, read
references/annotations-and-typing.md.
Related skills
godot-nodes-scenes — the scene tree, instancing, and autoloads.
godot-signals-groups — event-driven architecture with signals and groups.
godot-resources — data-driven design with custom Resource types.
godot-csharp — the same engine concepts using C#/.NET.
1---2name: godot-gdscript3description: >4 Write idiomatic GDScript for Godot 4.7: static typing, the node lifecycle5 (_ready/_process/_physics_process), @export/@onready/@tool annotations,6 signals, and await for asynchronous flow. Use when editing .gd scripts in a7 Godot project (project.godot), writing or debugging GDScript, or porting 3.x8 GDScript to 4.x (function signatures, yield to await, export to @export).9metadata:10 source: https://skillmd.com/skills/junmystery/godot-gdscript11---1213# Godot GDScript (4.x)1415Write correct, statically typed GDScript and use the node lifecycle and signal16system the way the engine intends. Targets **Godot 4.7** (GDScript 2.0).1718## When to use1920- Use when writing or fixing `.gd` files: declaring variables, functions, classes,21 using `@export`/`@onready`, connecting signals, or awaiting coroutines/signals.22- Use when porting Godot 3.x scripts to 4.x and the script no longer parses.2324**When *not* to use:** scene/node structure and instancing questions →25`godot-nodes-scenes`; signal *architecture*/decoupling patterns →26`godot-signals-groups`; using C# instead of GDScript → `godot-csharp`.2728## Core workflow29301. **Type everything you can.** GDScript 2.0 supports static types31 (`var hp: int = 10`, `func add(a: int, b: int) -> int:`). Types catch errors at32 parse time and speed up the VM. Use `:=` for inferred types.332. **Use the lifecycle callbacks for their purpose:** `_ready()` once when the node34 and its children enter the tree; `_process(delta)` every rendered frame;35 `_physics_process(delta)` on the fixed physics tick (use it for movement/physics).363. **Grab node references with `@onready`**, not in `_init()` — children do not exist37 until the node enters the tree.384. **Expose tunables with `@export`** so designers edit them in the Inspector.395. **React to events with signals + `await`**, not polling, where it reads cleanly.406. **Run and read errors.** The Debugger panel prints typed errors with line numbers;41 fix the first error first (later ones are often cascades).4243## Patterns4445### 1. A typed script with lifecycle, @export, and @onready4647```gdscript48extends Node2D49class_name Spinner # registers a global type usable in other scripts5051@export var speed: float = 90.0 # editable in the Inspector (degrees/sec)52@export_range(0, 10, 0.5) var wobble := 2.053@onready var sprite: Sprite2D = $Sprite2D # resolved when the node enters the tree5455func _ready() -> void:56 # Runs once, after children are ready. Safe to touch $Sprite2D here.57 sprite.modulate = Color.AQUA5859func _process(delta: float) -> void:60 # delta is seconds since last frame; multiply rates by it for FPS independence.61 rotation_degrees += speed * delta62```6364### 2. Signals: declare, emit, connect (4.x Callable syntax)6566```gdscript67extends Node6869signal health_changed(current: int, maximum: int) # typed signal params7071var health := 1007273func take_damage(amount: int) -> void:74 health = maxi(health - amount, 0) # maxi/maxf are typed; max() returns Variant75 health_changed.emit(health, 100) # 4.x: emit as a method on the signal7677func _ready() -> void:78 # 4.x: connect with a Callable, not a string method name.79 health_changed.connect(_on_health_changed)8081func _on_health_changed(current: int, maximum: int) -> void:82 print("HP: %d/%d" % [current, maximum])83```8485### 3. await — pause until a timer or signal fires (replaces 3.x yield)8687```gdscript88func flash_then_continue() -> void:89 modulate = Color.RED90 await get_tree().create_timer(0.2).timeout # resume after 0.2s91 modulate = Color.WHITE92 # await any signal: var result = await some_node.some_signal93```9495### 4. Lambdas, typed arrays, and safe access9697```gdscript98var enemies: Array[Node] = [] # typed array99100func cull_dead() -> void:101 enemies = enemies.filter(func(e): return e.is_inside_tree())102103func get_first_name(d: Dictionary) -> String:104 return d.get("name", "unknown") # default avoids missing-key errors105```106107## Pitfalls108109- **3.x → 4.x signal API changed.** `emit_signal("x")` still works but prefer110 `x.emit(...)`; `connect("x", self, "_on_x")` is gone — use `x.connect(_on_x)` with a111 Callable. `yield(obj, "sig")` is now `await obj.sig`.112- **`export var` is now `@export var`** (annotation). Likewise `onready`→`@onready`,113 `tool`→`@tool`, `remote`/`master` RPC keywords → the `@rpc(...)` annotation.114- **`@onready` and `$NodePath` in `_init()` fail** — the node isn't in the tree yet.115 Initialize node references in `_ready()` or with `@onready`.116- **Integer division truncates.** `5 / 2 == 2`. Use `5.0 / 2` or cast to `float`.117- **`_process` vs `_physics_process`.** Put `move_and_slide()` and physics in118 `_physics_process(delta)`; using `_process` makes motion frame-rate dependent.119- **`class_name` must be unique** project-wide and is required to use the type name in120 other scripts or as an Inspector type.121- **An override stops parsing after upgrading to 4.7** → since 4.7 an overriding method122 inherits the parent's typed return, so every path must `return` a value (add123 `return null` at the end if needed). Also new in 4.7: setting one element of a packed124 array property (`points[0] = v`) no longer calls that property's setter; reassign the125 whole array if the setter must run.126127## References128129- For the full annotation list, advanced typing, and style conventions, read130 `references/annotations-and-typing.md`.131132## Related skills133134- `godot-nodes-scenes` — the scene tree, instancing, and autoloads.135- `godot-signals-groups` — event-driven architecture with signals and groups.136- `godot-resources` — data-driven design with custom `Resource` types.137- `godot-csharp` — the same engine concepts using C#/.NET.