Module global

Expand description

Godot global enums, constants and utility functions.

See also Godot docs for @GlobalScope.

The library ships several additional enums in places where GDScript would use magic numbers. These are co-located with builtin types, in the godot::builtin module. The enums are:

Color: ColorChannelOrder
Projection: ProjectionEye, ProjectionPlane
Rectangle: Side, Corner _{(godot-generated)}
Rotation: EulerOrder _{(godot-generated)}
Variant: VariantType, VariantOperator
Vector: Vector2Axis, Vector3Axis, Vector4Axis

Macros§

godot_error: Pushes an error message to Godot’s built-in debugger and to the OS terminal.
godot_print: Prints to the Godot console.
godot_print_rich: Prints to the Godot console. Supports BBCode, color and URL tags.
godot_script_error: Logs a script error to Godot’s built-in debugger and to the OS terminal.
godot_warn: Pushes a warning message to Godot’s built-in debugger and to the OS terminal.

Structs§

Error
HorizontalAlignment
InlineAlignment
JoyAxis
JoyButton
Key
KeyLocation
KeyModifierMask
MethodFlags
MidiMessage: Godot enum name: MIDIMessage.
MouseButton
MouseButtonMask
PropertyHint
PropertyUsageFlags
VerticalAlignment

Enums§

ClockDirection: This enum is exhaustive; you should not expect future Godot versions to add new enumerators.
Orientation: This enum is exhaustive; you should not expect future Godot versions to add new enumerators.

Functions§