api

gdext.api
object api

The binding's public API surface. Game code imports gdext.api.* for the everyday helpers, alongside the three packages gdext.classes (engine classes), gdext.builtin (builtin types) and gdext.annotations (the registration annotations). Everything else under gdext.* is internal.

This object also exposes the small "generated-glue" surface the build's source generator targets — GodotEntry, Register and the entry FFI type aliases — so the generated entry point never names an internal package.

Attributes

Graph
Supertypes
class Object
trait Matchable
class Any
Self type
api.type

Members list

Type members

Classlikes

object Gd

The user-facing engine-glue facade. Holds object construction (Gd.create) and logging (Gd.print / Gd.printError / Gd.printWarning) — the one short handle game code reaches for. (The old Gd[T] smart-pointer TYPE is gone: an engine object is now held as its plain wrapper type, e.g. Node2D, and lifetime methods live directly on it.)

The user-facing engine-glue facade. Holds object construction (Gd.create) and logging (Gd.print / Gd.printError / Gd.printWarning) — the one short handle game code reaches for. (The old Gd[T] smart-pointer TYPE is gone: an engine object is now held as its plain wrapper type, e.g. Node2D, and lifetime methods live directly on it.)

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Gd.type
object GodotEntry

The library's GDExtension bootstrap, called by the generated entry point. A thin facade over the (internal) bootstrap so the heavy interface-loading / init-struct / hot-reload machinery stays hidden in the library.

The library's GDExtension bootstrap, called by the generated entry point. A thin facade over the (internal) bootstrap so the heavy interface-loading / init-struct / hot-reload machinery stays hidden in the library.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
GodotEntry.type
object Math

Numeric helpers mirroring Godot's @GlobalScope math utilities, for game code that wants the engine's exact semantics without an engine call. Reached as gdext.api.Math.

Numeric helpers mirroring Godot's @GlobalScope math utilities, for game code that wants the engine's exact semantics without an engine call. Reached as gdext.api.Math.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Math.type

Types

GDExtension entry-point FFI types, surfaced as public aliases so the generated entry can name them without importing gdext.internal.ffi.

GDExtension entry-point FFI types, surfaced as public aliases so the generated entry can name them without importing gdext.internal.ffi.

Attributes

Exports

Defined exports

final val ExportHint: ExportHint
Exported from register
final type ExportHint = ExportHint
Exported from register
final val Gc: Gc
Exported from internal
final val InstanceId: InstanceId
Exported from InstanceId$package
final type InstanceId = InstanceId
Exported from InstanceId$package$
final val Register: Register
Exported from register
final val Required: Required
Exported from engine
final type Required = Required
Exported from engine
final val Tres: Tres
Exported from engine
final type Tres = [T <: GodotScriptClass] =>> Tres[T]
Exported from engine
final val Tscn: Tscn
Exported from engine
final type Tscn = [T <: GodotScriptClass] =>> Tscn[T]
Exported from engine