gdscript-syntax-guide_skill

Overview

This skill is an authoritative GDScript syntax and style guide tailored for Godot 4.5. It enforces syntax accuracy, tab-based indentation rules, type-safety practices, and consistent naming conventions to produce clean, maintainable code. The guide targets game developers writing GDScript and teams standardizing their codebase.

How this skill works

The guide inspects code structure, indentation, type annotations, signal usage, node access patterns, and export/property declarations against Godot 4.5 best practices. It highlights correct and incorrect patterns, recommends editor settings (tab width = 4 display), and describes safe runtime checks, memory handling, and performance optimizations. Use it to validate style, improve readability, and reduce runtime errors.

When to use it

• When starting a new Godot 4.5 project to establish a consistent code style.
• During code reviews to enforce tab-based indentation and naming rules.
• When converting legacy GDScript to strongly-typed Godot 4.5 style.
• Before merging patches to catch unsafe node access or signal misuse.
• When optimizing performance, memory, or reducing runtime type errors.

Best practices

• Always use tab characters for indentation; configure editor to display tabs as 4 spaces.
• Prefer strong typing: annotate variables, parameters, and return types.
• Use snake_case for variables and functions, PascalCase for class names, UPPER_SNAKE_CASE for constants.
• Type-check nodes and resources with is and as; prefer @onready for cached node references.
• Use @export with typed properties and typed signals for editor safety and clarity.
• Cache frequently used nodes and avoid unnecessary type conversions to reduce overhead.

Example use cases

• Defining a typed CharacterController with @onready cached nodes and typed signals.
• Implementing a pooled bullet system that reuses instances to avoid frequent allocations.
• Writing safe resource loaders with file existence checks and JSON parse handling.
• Standardizing project imports, preloads, and grouped node lookups for team collaboration.
• Refactoring input handling into structured, type-checked handlers for keyboard, mouse, and controller.