API (Scaladoc)¶
The Scaladoc is generated from the binding's sources on every docs build. It
documents the current main branch, which may be ahead of the latest
release.
Public packages¶
| Package | Contents |
|---|---|
gdext.api |
Everyday helpers: Gd.create, Gd.scoped, Gd.wrap, Gd.print, Gc, Tres, Tscn, Required, ExportHint, emitSignal, Math. |
gdext.annotations |
@func, @signal, @gdexport, inspector sections, component-reference dropdowns. |
gdext.builtin |
Builtin value types: math types, Color, Arr, Dict, packed arrays. |
gdext.classes |
About 1000 engine classes generated from Godot's extension_api.json. |
Everything under gdext.internal is an implementation detail. Much of it is
private[gdext], so game code cannot reach it anyway.
Engine class naming¶
Engine classes keep Godot's names. Methods are camelCase versions of Godot's snake_case methods:
| Godot | Scala |
|---|---|
Node2D.set_position(pos) |
setPosition(pos) |
Node.queue_free() |
queueFree() |
FileAccess.get_file_as_string(path) |
FileAccess.getFileAsString(path) |
For what each engine method does, Godot's class reference is the authoritative source.