Godot Object Compiler Documentation

The Godot Object Compiler is a code generation tool for GDExtensions. It generates bindings and other builderplate code for efficent development in C++ while maintaining full configurability via expressive macros generated directly from the godot-cpp source used to build your extension.

Check out the Example for a general overview of the features and Generated Code Example for a peek at the generated code.

Warning

This is experimental software, please do not use this application in a production environment. This project is currently only tested on Linux. Everything is still subject to change.

Examples

• Example
  • Classes
  • Properties
  • Signals
  • Functions
  • Enums
  • Usage
    • CMake Integration
    • SConstruct Integration
    • Command Line Usage
• Generated Code Example

Macros

• Macros
  • GODOT_CLASS
    • Usage
    • Available Parameter Types
  • GODOT_ENUM
    • Usage
    • Available Parameter Types
  • GODOT_PROPERTY
    • Usage
    • Available Parameter Types
  • GODOT_FUNCTION
    • Usage
    • Available Parameter Types
  • GODOT_SIGNAL
    • Usage
  • GODOT_CATEGORY
    • Usage
  • GODOT_GROUP
    • Usage
  • GODOT_SUBGROUP
    • Usage
  • GODOT_GENERATED_BODY
    • Usage
  • GODOT_GENERATED_GLOBAL
    • Usage
  • Exclude Code
  • Example

Integrations

• Integrations
  • CMake
  • SConstruct

Using the CLI

• Using the CLI
  • build_num
  • clear
    • clear generated
    • clear type_db
    • clear imported_type_db
  • export type_db
  • generate
    • generate bindings
    • generate type_db
  • help
  • import type_db
  • init
    • init tools
    • init local_resources
  • print parsed
  • print transformed
  • print type
  • version