godot-best-practices

# Classes: PascalCase
class_name PlayerController
extends CharacterBody2D
 
# Signals: past_tense_snake_case (describe what happened)
signal health_changed(new_health: int)
signal player_died
signal item_collected(item: Item)
 
# Constants: SCREAMING_SNAKE_CASE
const MAX_SPEED: float = 200.0
const JUMP_FORCE: int = -400
 
# Variables and functions: snake_case
var current_health: int = 100
var _private_variable: float = 0.0  # Leading underscore for private
 
func calculate_damage(base: int, multiplier: float) -> int:
    return int(base * multiplier)
 
func _private_helper() -> void:  # Leading underscore for private
    pass

# Variable declarations
var speed: float = 100.0
var player: CharacterBody2D
var items: Array[Item] = []
var stats: Dictionary = {}
 
# Function signatures with return types
func get_damage() -> int:
    return _base_damage * _multiplier
 
func find_nearest_enemy(position: Vector2) -> Enemy:
    # Implementation
    return null
 
# Typed signals (Godot 4.x)
signal score_updated(new_score: int, old_score: int)
signal target_acquired(target: Node2D, distance: float)
 
# Node references with types
@onready var sprite: Sprite2D = $Sprite2D
@onready var collision: CollisionShape2D = $CollisionShape2D
@onready var animation_player: AnimationPlayer = %AnimationPlayer

# PREFER: @onready with type hints
@onready var health_bar: ProgressBar = $UI/HealthBar
@onready var weapon: Weapon = $WeaponMount/Weapon
 
# PREFER: Unique names with % for critical nodes
@onready var player: Player = %Player
@onready var game_manager: GameManager = %GameManager
 
# AVOID: get_node() in _ready()
func _ready() -> void:
    # Don't do this
    var sprite = get_node("Sprite2D")
 
# AVOID: Deep fragile paths
@onready var thing = $Parent/Child/GrandChild/GreatGrandChild  # Fragile

# Child node emits signals (doesn't know about parent)
class_name HealthComponent
extends Node
 
signal health_changed(current: int, maximum: int)
signal died
 
var _health: int = 100
var _max_health: int = 100
 
func take_damage(amount: int) -> void:
    _health = max(0, _health - amount)
    health_changed.emit(_health, _max_health)
    if _health <= 0:
        died.emit()

# Parent connects to child signals (knows about children)
class_name Player
extends CharacterBody2D
 
@onready var health: HealthComponent = $HealthComponent
@onready var sprite: Sprite2D = $Sprite2D
 
func _ready() -> void:
    health.health_changed.connect(_on_health_changed)
    health.died.connect(_on_died)
 
func _on_health_changed(current: int, maximum: int) -> void:
    # Update UI, play effects, etc.
    pass
 
func _on_died() -> void:
    sprite.modulate = Color.RED
    queue_free()

# preload(): Compile-time loading for critical/small assets
const BULLET_SCENE: PackedScene = preload("res://scenes/bullet.tscn")
const PLAYER_SPRITE: Texture2D = preload("res://sprites/player.png")
const DAMAGE_SOUND: AudioStream = preload("res://audio/damage.wav")
 
# load(): Runtime loading for optional/large assets
func load_level(level_name: String) -> void:
    var path := "res://levels/%s.tscn" % level_name
    var level_scene: PackedScene = load(path)
    var level := level_scene.instantiate()
    add_child(level)
 
# ResourceLoader for async loading (prevents stuttering)
func _load_level_async(path: String) -> void:
    ResourceLoader.load_threaded_request(path)
    # Check with: ResourceLoader.load_threaded_get_status(path)
    # Get with: ResourceLoader.load_threaded_get(path)

class_name MyClass
extends Node2D
## Brief description of this class.
##
## Longer description if needed, explaining purpose and usage.
 
# === Signals ===
signal state_changed(new_state: State)
 
# === Enums ===
enum State { IDLE, RUNNING, JUMPING }
 
# === Exports ===
@export var speed: float = 100.0
@export_group("Combat")
@export var damage: int = 10
@export var attack_range: float = 50.0
 
# === Constants ===
const MAX_HEALTH: int = 100
 
# === Public Variables ===
var current_state: State = State.IDLE
 
# === Private Variables ===
var _internal_counter: int = 0
 
# === Onready ===
@onready var sprite: Sprite2D = $Sprite2D
@onready var collision: CollisionShape2D = $CollisionShape2D
 
# === Lifecycle Methods ===
func _ready() -> void:
    pass
 
func _process(delta: float) -> void:
    pass
 
func _physics_process(delta: float) -> void:
    pass
 
# === Public Methods ===
func take_damage(amount: int) -> void:
    pass
 
# === Private Methods ===
func _calculate_knockback() -> Vector2:
    return Vector2.ZERO

# Basic exports
@export var health: int = 100
@export var speed: float = 200.0
@export var player_name: String = "Player"
 
# Range constraints
@export_range(0, 100) var percentage: int = 50
@export_range(0.0, 1.0, 0.1) var volume: float = 0.8
 
# Resource exports
@export var texture: Texture2D
@export var scene: PackedScene
@export var audio: AudioStream
 
# Grouped exports
@export_group("Movement")
@export var walk_speed: float = 100.0
@export var run_speed: float = 200.0
 
@export_group("Combat")
@export var attack_damage: int = 10
 
# Enum exports
@export var difficulty: Difficulty = Difficulty.NORMAL
enum Difficulty { EASY, NORMAL, HARD }
 
# Flags (multiselect)
@export_flags("Fire", "Water", "Earth", "Air") var elements: int = 0

enum State { IDLE, WALK, JUMP, ATTACK }
 
var current_state: State = State.IDLE
 
func _physics_process(delta: float) -> void:
    match current_state:
        State.IDLE:
            _process_idle(delta)
        State.WALK:
            _process_walk(delta)
        State.JUMP:
            _process_jump(delta)
        State.ATTACK:
            _process_attack(delta)
 
func change_state(new_state: State) -> void:
    if current_state == new_state:
        return
    _exit_state(current_state)
    current_state = new_state
    _enter_state(new_state)

class_name ObjectPool
extends Node
 
var _pool: Array[Node] = []
var _scene: PackedScene
 
func _init(scene: PackedScene, initial_size: int = 10) -> void:
    _scene = scene
    for i in initial_size:
        var obj := _scene.instantiate()
        obj.set_process(false)
        _pool.append(obj)
 
func acquire() -> Node:
    if _pool.is_empty():
        return _scene.instantiate()
    var obj := _pool.pop_back()
    obj.set_process(true)
    return obj
 
func release(obj: Node) -> void:
    obj.set_process(false)
    _pool.append(obj)

# Custom Resource for save data
class_name SaveData
extends Resource
 
@export var player_position: Vector2
@export var player_health: int
@export var inventory: Array[String]
@export var level_name: String
 
# Save
func save_game(data: SaveData) -> void:
    ResourceSaver.save(data, "user://save.tres")
 
# Load
func load_game() -> SaveData:
    if ResourceLoader.exists("user://save.tres"):
        return load("user://save.tres") as SaveData
    return SaveData.new()