godot-core 0.5.3

Internal crate used by godot-rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

/*
 * Copyright (c) godot-rust; Bromeon and contributors.
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at https://mozilla.org/MPL/2.0/.
 */

//! Types and traits related to objects.
//!
//! The most important symbols in this module are:
//! * [`GodotClass`], which is implemented for every class that Godot can work with (either engine- or user-provided).
//! * [`Gd`], a smart pointer that manages instances of Godot classes.

mod base;
mod dyn_gd;
mod gd;
mod gd_duplicate;
mod guards;
mod instance_id;
mod on_editor;
mod on_ready;
mod passive_gd;
mod raw_gd;
mod traits;

mod base_init;
#[cfg(since_api = "4.7")] #[cfg_attr(published_docs, doc(cfg(since_api = "4.7")))]
mod base_strong_initialization;
#[cfg(before_api = "4.7")] #[cfg_attr(published_docs, doc(cfg(before_api = "4.7")))]
mod base_weak_initialization;
pub(crate) mod rtti;
// TODO(v0.6): godot::obj::signal was accidentally public; kept for SemVer -> remove in next minor. Canonical is godot::signal.
#[doc(hidden)]
pub mod signal {
    pub mod re_export {
        pub use crate::signal::{
            ConnectBuilder, ConnectHandle, IndirectSignalReceiver, SignalReceiver, TypedSignal,
        };
    }
    pub mod priv_re_export {
        pub use crate::signal::priv_re_export::*;
    }
}

pub use base::*;
pub use dyn_gd::DynGd;
pub use gd::*;
pub use gd_duplicate::{ExDuplicateNode, ExDuplicateResource};
pub use guards::{BaseMut, BaseRef, DynGdMut, DynGdRef, GdMut, GdRef};
pub use instance_id::*;
pub use on_editor::*;
pub use on_ready::*;
pub(crate) use passive_gd::PassiveGd;
pub use raw_gd::*;
pub use traits::*;

pub mod bounds;
pub mod script;
pub use bounds::private::Bounds;

// Do not re-export rtti here.

/// Resolves the type to which a `Gd<T>` dereferences.
///
/// This type alias abstracts over the two `Declarer` options for Godot objects:
/// - [`bounds::DeclEngine`]: for all engine-provided classes, `DerefTarget<T>` is `T`.
/// - [`bounds::DeclUser`]: for Rust-defined user classes, `DerefTarget<T>` is `T::Base`.
type GdDerefTarget<T> = <<T as Bounds>::Declarer as bounds::Declarer>::DerefTarget<T>;