Docs.rs
  • godot-core-0.3.4
    • godot-core 0.3.4
    • Permalink
    • Docs.rs crate page
    • MPL-2.0
    • Links
    • Homepage
    • Repository
    • crates.io
    • Source
    • Owners
    • Bromeon
    • Dependencies
      • glam ^0.30 normal
      • godot-cell =0.3.4 normal
      • godot-ffi =0.3.4 normal
      • serde ^1 normal optional
      • serde_json ^1 dev
      • godot-bindings =0.3.4 build
      • godot-codegen =0.3.4 build
    • Versions
    • 44.88% of the crate is documented
  • Platform
    • i686-pc-windows-msvc
    • i686-unknown-linux-gnu
    • x86_64-apple-darwin
    • x86_64-pc-windows-msvc
    • x86_64-unknown-linux-gnu
  • Feature flags
  • docs.rs
    • About docs.rs
    • Badges
    • Builds
    • Metadata
    • Shorthand URLs
    • Download
    • Rustdoc JSON
    • Build queue
    • Privacy policy
  • Rust
    • Rust website
    • The Book
    • Standard Library API Reference
    • Rust by Example
    • The Cargo Guide
    • Clippy Documentation

Crate godot_core

godot_core0.3.4

  • All Items

Sections

  • Internal crate of godot-rust

Crate Items

  • Re-exports
  • Modules
  • Macros
  • Functions

Crates

  • godot_core

Crate godot_core

Source
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 and Variant.
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
tasksince_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 standard vec! 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
dictDeprecated
emit_deprecated_warning
format_backtraceDebug-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_sendsince_api="4.2"
impl_godot_as_self
impl_shared_string_api
implement_godot_bounds
Implements Bounds for a user-defined class.
inherit_from_ArrayMesh__ensure_class_exists
Safety
inherit_from_CanvasItem__ensure_class_exists
inherit_from_ClassDb__ensure_class_exists
inherit_from_EditorExportPlugin__ensure_class_exists
Safety
inherit_from_EditorPlugin__ensure_class_exists
Safety
inherit_from_Engine__ensure_class_exists
inherit_from_FileAccess__ensure_class_exists
inherit_from_GDScript__ensure_class_exists
Safety
inherit_from_HttpRequest__ensure_class_exists
Safety
inherit_from_InputEventAction__ensure_class_exists
Safety
inherit_from_InputEvent__ensure_class_exists
inherit_from_Input__ensure_class_exists
inherit_from_MainLoop__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_PackedScene__ensure_class_exists
Safety
inherit_from_PrimitiveMesh__ensure_class_exists
Safety
inherit_from_RefCounted__ensure_class_exists
Safety
inherit_from_RenderingServer__ensure_class_exists
inherit_from_ResourceFormatLoader__ensure_class_exists
Safety
inherit_from_ResourceLoader__ensure_class_exists
inherit_from_ResourceSaver__ensure_class_exists
inherit_from_Resource__ensure_class_exists
Safety
inherit_from_SceneTree__ensure_class_exists
Safety
inherit_from_ScriptExtension__ensure_class_exists
Safety
inherit_from_ScriptLanguageExtension__ensure_class_exists
Safety
inherit_from_ScriptLanguage__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
match_class
Dispatches a class to different subclasses.
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() and Object::tr_ex() methods.
tr_n
A convenience macro for using the Object::tr_n() and Object::tr_n_ex() methods.
varray
Constructs [VariantArray] literals, similar to Rust’s standard vec! macro.
vdict
Constructs [Dictionary] literals, close to Godot’s own syntax.
vslice
Constructs a slice of [Variant] literals, useful for passing to vararg functions.

Functions§

get_gdext_panic_context
set_gdext_hook

Results

Settings
Help
    trait
    godot_core::obj::WithBaseField
    Trait that is automatically implemented for user classes …
    method
    godot_core::obj::WithBaseField::base
    &WithBaseField -> BaseRef<WithBaseField>
    Returns a shared reference suitable for calling engine …
    trait method
    godot_core::obj::WithBaseField::to_gd
    &WithBaseField -> Gd<WithBaseField>
    Returns the Gd pointer containing this object.
    method
    godot_core::obj::WithBaseField::base_mut
    &mut WithBaseField -> BaseMut<WithBaseField>
    Returns a mutable reference suitable for calling engine …
    trait method
    godot_core::obj::WithBaseField::base_field
    &WithBaseField -> &Base<GodotClass::Base>
    Returns a reference to the Base stored by this object.
No results :(
Try on DuckDuckGo?

Or try looking in one of these:
  • The Rust Reference for technical details about the language.
  • Rust By Example for expository code examples.
  • The Rust Book for introductions to language features and the language itself.
  • Docs.rs for documentation of crates released on crates.io.