Expand description
§Internal crate of godot-rust
Do not depend on this crate directly, instead use the godot
crate.
No SemVer or other guarantees are provided.
Re-exports§
pub use godot_ffi as sys;
Modules§
- builder
- builtin
- Built-in types like
Vector2
,GString
andVariant
. - classes
- Maps the Godot class API to Rust.
- global
- Godot global enums, constants and utility functions.
- init
- meta
- Meta-information about Godot types, their properties and conversions between them.
- obj
- Types and traits related to objects.
- registry
- task
since_api="4.2"
- Integrates async rust code with the engine.
- tools
- Higher-level additions to the Godot engine API.
Macros§
- array
- Constructs [
Array
] literals, similar to Rust’s standardvec!
macro. - assert_
eq_ approx - Asserts that two values are approximately equal
- assert_
ne_ approx - Asserts that two values are not approximately equal, using the provided
func
for equality checking. - declare_
arg_ method - dict
- Constructs [
Dictionary
] literals, close to Godot’s own syntax. - emit_
deprecated_ warning - format_
backtrace Debug-assertions enabled - 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_
str - Concatenates format-style arguments into a
GString
. - godot_
warn - Pushes a warning message to Godot’s built-in debugger and to the OS terminal.
- impl_
asarg_ by_ ref - impl_
asarg_ by_ value - impl_
dynamic_ send since_api="4.2"
- impl_
godot_ as_ self - impl_
shared_ string_ api - implement_
godot_ bounds - Implements
Bounds
for a user-defined class. - inherit_
from_ Array Mesh__ ensure_ class_ exists - Safety
- inherit_
from_ Canvas Item__ ensure_ class_ exists - inherit_
from_ Class Db__ ensure_ class_ exists - inherit_
from_ Editor Export Plugin__ ensure_ class_ exists - Safety
- inherit_
from_ Editor Plugin__ ensure_ class_ exists - Safety
- inherit_
from_ Engine__ ensure_ class_ exists - inherit_
from_ File Access__ ensure_ class_ exists - inherit_
from_ GDScript__ ensure_ class_ exists - Safety
- inherit_
from_ Http Request__ ensure_ class_ exists - Safety
- inherit_
from_ Input Event Action__ ensure_ class_ exists - Safety
- inherit_
from_ Input Event__ ensure_ class_ exists - inherit_
from_ Input__ ensure_ class_ exists - inherit_
from_ Main Loop__ ensure_ class_ exists - Safety
- inherit_
from_ Mesh__ ensure_ class_ exists - Safety
- inherit_
from_ Node2D__ ensure_ class_ exists - Safety
- inherit_
from_ Node3D__ ensure_ class_ exists - Safety
- inherit_
from_ Node__ ensure_ class_ exists - Safety
- inherit_
from_ Object__ ensure_ class_ exists - Safety
- inherit_
from_ Os__ ensure_ class_ exists - inherit_
from_ Packed Scene__ ensure_ class_ exists - Safety
- inherit_
from_ Primitive Mesh__ ensure_ class_ exists - Safety
- inherit_
from_ RefCounted__ ensure_ class_ exists - Safety
- inherit_
from_ Rendering Server__ ensure_ class_ exists - inherit_
from_ Resource Format Loader__ ensure_ class_ exists - Safety
- inherit_
from_ Resource Loader__ ensure_ class_ exists - inherit_
from_ Resource Saver__ ensure_ class_ exists - inherit_
from_ Resource__ ensure_ class_ exists - Safety
- inherit_
from_ Scene Tree__ ensure_ class_ exists - Safety
- inherit_
from_ Script Extension__ ensure_ class_ exists - Safety
- inherit_
from_ Script Language Extension__ ensure_ class_ exists - Safety
- inherit_
from_ Script Language__ ensure_ class_ exists - inherit_
from_ Script__ ensure_ class_ exists - inherit_
from_ Texture__ ensure_ class_ exists - Safety
- inherit_
from_ Time__ ensure_ class_ exists - inherit_
from_ Viewport__ ensure_ class_ exists - inherit_
from_ Window__ ensure_ class_ exists - Safety
- real
- A macro to coerce float-literals into the [
real
] type. - reals
- Array of [
real
]s. - swizzle
- Access vector components in different order.
- tr
- A convenience macro for using the
Object::tr()
andObject::tr_ex()
methods. - tr_n
- A convenience macro for using the
Object::tr_n()
andObject::tr_n_ex()
methods. - varray
- Constructs [
VariantArray
] literals, similar to Rust’s standardvec!
macro.