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
- tools
- Higher-level additions to the Godot engine API.
Macros§
- arg_
into_ owned - Converts
impl AsArg<T>
into a locally validT
. - arg_
into_ ref - Converts
impl AsArg<T>
into a locally valid&T
. - 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 - 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.
- impl_
asarg_ by_ ref - impl_
asarg_ by_ value - impl_
godot_ as_ self - impl_
shared_ string_ api - implement_
godot_ bounds - Implements
Bounds
for a user-defined class. - real
- A macro to coerce float-literals into the [
real
] type. - reals
- Array of reals.
- 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. - unsafe_
inherits_ transitive_ Animated Sprite2D - Safety
- unsafe_
inherits_ transitive_ Area2D - Safety
- unsafe_
inherits_ transitive_ Array Mesh - Safety
- unsafe_
inherits_ transitive_ Audio Stream Player - Safety
- unsafe_
inherits_ transitive_ Base Button - Safety
- unsafe_
inherits_ transitive_ BoxMesh - Safety
- unsafe_
inherits_ transitive_ Button - Safety
- unsafe_
inherits_ transitive_ Camera2D - Safety
- unsafe_
inherits_ transitive_ Camera3D - Safety
- unsafe_
inherits_ transitive_ Canvas Item - Safety
- unsafe_
inherits_ transitive_ Canvas Layer - Safety
- unsafe_
inherits_ transitive_ Class Db - Safety
- unsafe_
inherits_ transitive_ Collision Object2D - Safety
- unsafe_
inherits_ transitive_ Collision Shape2D - Safety
- unsafe_
inherits_ transitive_ Control - Safety
- unsafe_
inherits_ transitive_ Editor Export Plugin - Safety
- unsafe_
inherits_ transitive_ Editor Plugin - Safety
- unsafe_
inherits_ transitive_ Engine - Safety
- unsafe_
inherits_ transitive_ File Access - Safety
- unsafe_
inherits_ transitive_ GDScript - Safety
- unsafe_
inherits_ transitive_ Http Request - Safety
- unsafe_
inherits_ transitive_ Image - Safety
- unsafe_
inherits_ transitive_ Image Texture Layered - Safety
- unsafe_
inherits_ transitive_ Input - Safety
- unsafe_
inherits_ transitive_ Input Event - Safety
- unsafe_
inherits_ transitive_ Input Event Action - Safety
- unsafe_
inherits_ transitive_ Label - Safety
- unsafe_
inherits_ transitive_ Main Loop - Safety
- unsafe_
inherits_ transitive_ Marker2D - Safety
- unsafe_
inherits_ transitive_ Mesh - Safety
- unsafe_
inherits_ transitive_ Node - Safety
- unsafe_
inherits_ transitive_ Node2D - Safety
- unsafe_
inherits_ transitive_ Node3D - Safety
- unsafe_
inherits_ transitive_ Node3D Gizmo - Safety
- unsafe_
inherits_ transitive_ Object - Safety
- unsafe_
inherits_ transitive_ Os - Safety
- unsafe_
inherits_ transitive_ Packed Scene - Safety
- unsafe_
inherits_ transitive_ Path Follow2D - Safety
- unsafe_
inherits_ transitive_ Physics Body2D - Safety
- unsafe_
inherits_ transitive_ Primitive Mesh - Safety
- unsafe_
inherits_ transitive_ RefCounted - Safety
- unsafe_
inherits_ transitive_ Rendering Server - Safety
- unsafe_
inherits_ transitive_ Resource - Safety
- unsafe_
inherits_ transitive_ Resource Format Loader - Safety
- unsafe_
inherits_ transitive_ Resource Loader - Safety
- unsafe_
inherits_ transitive_ Resource Saver - Safety
- unsafe_
inherits_ transitive_ Rigid Body2D - Safety
- unsafe_
inherits_ transitive_ Scene Tree - Safety
- unsafe_
inherits_ transitive_ Scene Tree Timer - Safety
- unsafe_
inherits_ transitive_ Script - Safety
- unsafe_
inherits_ transitive_ Script Extension - Safety
- unsafe_
inherits_ transitive_ Script Language - Safety
- unsafe_
inherits_ transitive_ Script Language Extension - Safety
- unsafe_
inherits_ transitive_ Sprite2D - Safety
- unsafe_
inherits_ transitive_ Sprite Frames - Safety
- unsafe_
inherits_ transitive_ Text Server - Safety
- unsafe_
inherits_ transitive_ Text Server Extension - Safety
- unsafe_
inherits_ transitive_ Texture - Safety
- unsafe_
inherits_ transitive_ Texture2D Array - Safety
- unsafe_
inherits_ transitive_ Texture Layered - Safety
- unsafe_
inherits_ transitive_ Time - Safety
- unsafe_
inherits_ transitive_ Timer - Safety
- unsafe_
inherits_ transitive_ Viewport - Safety
- unsafe_
inherits_ transitive_ Window - Safety
- varray
- Constructs [
VariantArray
] literals, similar to Rust’s standardvec!
macro.