Struct gdnative::prelude::Timer

pub struct Timer { /* fields omitted */ }

core class Timer inherits Node (unsafe).

Official documentation

See the documentation of this class in the Godot engine's official documentation.

Memory management

Non reference counted objects such as the ones of this type are usually owned by the engine.

Timer is a reference-only type. Persistent references can only exist in the unsafe Ref<Timer> form.

In the cases where Rust code owns an object of this type, for example if the object was just created on the Rust side and not passed to the engine yet, ownership should be either given to the engine or the object must be manually destroyed using Ptr::free, or Ptr::queue_free if it is a Node.

Class hierarchy

Timer inherits methods from:

• Node
• Object

Safety

All types in the Godot API have "interior mutability" in Rust parlance. To enforce that the official thread-safety guidelines are followed, the typestate pattern is used in the Ref and TRef smart pointers, and the Instance API. The typestate Access in these types tracks whether the access is unique, shared, or exclusive to the current thread. For more information, see the type-level documentation on Ref.

Implementations

impl Timer

Constants

pub const TIMER_PROCESS_IDLE: i64

pub const TIMER_PROCESS_PHYSICS: i64

impl Timer

pub fn new() -> Ref<Timer, Unique>

Creates a new instance of this object.

Because this type is not reference counted, the lifetime of the returned object is not automatically managed.

Immediately after creation, the object is owned by the caller, and can be passed to the engine (in which case the engine will be responsible for destroying the object) or destroyed manually using Ptr::free, or preferably Ptr::queue_free if it is a Node.

pub fn time_left(&self) -> f64

pub fn timer_process_mode(&self) -> TimerProcessMode

pub fn wait_time(&self) -> f64

pub fn has_autostart(&self) -> bool

pub fn is_one_shot(&self) -> bool

pub fn is_paused(&self) -> bool

pub fn is_stopped(&self) -> bool

pub fn set_autostart(&self, enable: bool)

pub fn set_one_shot(&self, enable: bool)

pub fn set_paused(&self, paused: bool)

pub fn set_timer_process_mode(&self, mode: i64)

pub fn set_wait_time(&self, time_sec: f64)

pub fn start(&self, time_sec: f64)

pub fn stop(&self)

Methods from Deref<Target = Node>

pub const DUPLICATE_GROUPS: i64

pub const DUPLICATE_SCRIPTS: i64

pub const DUPLICATE_SIGNALS: i64

pub const DUPLICATE_USE_INSTANCING: i64

pub const NOTIFICATION_APP_PAUSED: i64

pub const NOTIFICATION_APP_RESUMED: i64

pub const NOTIFICATION_CRASH: i64

pub const NOTIFICATION_DRAG_BEGIN: i64

pub const NOTIFICATION_DRAG_END: i64

pub const NOTIFICATION_ENTER_TREE: i64

pub const NOTIFICATION_EXIT_TREE: i64

pub const NOTIFICATION_INSTANCED: i64

pub const NOTIFICATION_INTERNAL_PHYSICS_PROCESS: i64

pub const NOTIFICATION_INTERNAL_PROCESS: i64

pub const NOTIFICATION_MOVED_IN_PARENT: i64

pub const NOTIFICATION_OS_IME_UPDATE: i64

pub const NOTIFICATION_OS_MEMORY_WARNING: i64

pub const NOTIFICATION_PARENTED: i64

pub const NOTIFICATION_PATH_CHANGED: i64

pub const NOTIFICATION_PAUSED: i64

pub const NOTIFICATION_PHYSICS_PROCESS: i64

pub const NOTIFICATION_PROCESS: i64

pub const NOTIFICATION_READY: i64

pub const NOTIFICATION_TRANSLATION_CHANGED: i64

pub const NOTIFICATION_UNPARENTED: i64

pub const NOTIFICATION_UNPAUSED: i64

pub const NOTIFICATION_WM_ABOUT: i64

pub const NOTIFICATION_WM_FOCUS_IN: i64

pub const NOTIFICATION_WM_FOCUS_OUT: i64

pub const NOTIFICATION_WM_GO_BACK_REQUEST: i64

pub const NOTIFICATION_WM_MOUSE_ENTER: i64

pub const NOTIFICATION_WM_MOUSE_EXIT: i64

pub const NOTIFICATION_WM_QUIT_REQUEST: i64

pub const NOTIFICATION_WM_UNFOCUS_REQUEST: i64

pub const PAUSE_MODE_INHERIT: i64

pub const PAUSE_MODE_PROCESS: i64

pub const PAUSE_MODE_STOP: i64

pub fn add_child(&self, node: impl AsArg<Node>, legible_unique_name: bool)

pub fn add_child_below_node(
    &self,
    node: impl AsArg<Node>,
    child_node: impl AsArg<Node>,
    legible_unique_name: bool
)

pub fn add_to_group(&self, group: impl Into<GodotString>, persistent: bool)

pub fn can_process(&self) -> bool

pub fn duplicate(&self, flags: i64) -> Option<Ref<Node, Shared>>

pub fn find_node(
    &self,
    mask: impl Into<GodotString>,
    recursive: bool,
    owned: bool
) -> Option<Ref<Node, Shared>>

pub fn find_parent(
    &self,
    mask: impl Into<GodotString>
) -> Option<Ref<Node, Shared>>

pub fn get_child(&self, idx: i64) -> Option<Ref<Node, Shared>>

pub fn get_child_count(&self) -> i64

pub fn get_children(&self) -> VariantArray<Shared>

pub fn custom_multiplayer(&self) -> Option<Ref<MultiplayerAPI, Shared>>

pub fn filename(&self) -> GodotString

pub fn get_groups(&self) -> VariantArray<Shared>

pub fn get_index(&self) -> i64

pub fn multiplayer(&self) -> Option<Ref<MultiplayerAPI, Shared>>

pub fn name(&self) -> GodotString

pub fn get_network_master(&self) -> i64

pub fn get_node(&self, path: impl Into<NodePath>) -> Option<Ref<Node, Shared>>

pub fn get_node_and_resource(
    &self,
    path: impl Into<NodePath>
) -> VariantArray<Shared>

pub fn get_node_or_null(
    &self,
    path: impl Into<NodePath>
) -> Option<Ref<Node, Shared>>

pub fn owner(&self) -> Option<Ref<Node, Shared>>

pub fn get_parent(&self) -> Option<Ref<Node, Shared>>

pub fn get_path(&self) -> NodePath

pub fn get_path_to(&self, node: impl AsArg<Node>) -> NodePath

pub fn pause_mode(&self) -> PauseMode

pub fn get_physics_process_delta_time(&self) -> f64

pub fn get_position_in_parent(&self) -> i64

pub fn get_process_delta_time(&self) -> f64

pub fn process_priority(&self) -> i64

pub fn get_scene_instance_load_placeholder(&self) -> bool

pub fn get_tree(&self) -> Option<Ref<SceneTree, Shared>>

pub fn get_viewport(&self) -> Option<Ref<Viewport, Shared>>

pub fn has_node(&self, path: impl Into<NodePath>) -> bool

pub fn has_node_and_resource(&self, path: impl Into<NodePath>) -> bool

pub fn is_a_parent_of(&self, node: impl AsArg<Node>) -> bool

pub fn is_displayed_folded(&self) -> bool

pub fn is_greater_than(&self, node: impl AsArg<Node>) -> bool

pub fn is_in_group(&self, group: impl Into<GodotString>) -> bool

pub fn is_inside_tree(&self) -> bool

pub fn is_network_master(&self) -> bool

pub fn is_physics_processing(&self) -> bool

pub fn is_physics_processing_internal(&self) -> bool

pub fn is_processing(&self) -> bool

pub fn is_processing_input(&self) -> bool

pub fn is_processing_internal(&self) -> bool

pub fn is_processing_unhandled_input(&self) -> bool

pub fn is_processing_unhandled_key_input(&self) -> bool

pub fn move_child(&self, child_node: impl AsArg<Node>, to_position: i64)

pub fn print_stray_nodes(&self)

pub fn print_tree(&self)

pub fn print_tree_pretty(&self)

pub fn propagate_call(
    &self,
    method: impl Into<GodotString>,
    args: VariantArray<Shared>,
    parent_first: bool
)

pub fn propagate_notification(&self, what: i64)

pub fn queue_free(&self)

pub fn raise(&self)

pub fn remove_and_skip(&self)

pub fn remove_child(&self, node: impl AsArg<Node>)

pub fn remove_from_group(&self, group: impl Into<GodotString>)

pub fn replace_by(&self, node: impl AsArg<Node>, keep_data: bool)

pub fn request_ready(&self)

pub fn rpc(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_config(&self, method: impl Into<GodotString>, mode: i64)

pub fn rpc_id(
    &self,
    peer_id: i64,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_unreliable(
    &self,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rpc_unreliable_id(
    &self,
    peer_id: i64,
    method: impl Into<GodotString>,
    varargs: &[Variant]
) -> Variant

pub fn rset(&self, property: impl Into<GodotString>, value: impl OwnedToVariant)

pub fn rset_config(&self, property: impl Into<GodotString>, mode: i64)

pub fn rset_id(
    &self,
    peer_id: i64,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn rset_unreliable(
    &self,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn rset_unreliable_id(
    &self,
    peer_id: i64,
    property: impl Into<GodotString>,
    value: impl OwnedToVariant
)

pub fn set_custom_multiplayer(&self, api: impl AsArg<MultiplayerAPI>)

pub fn set_display_folded(&self, fold: bool)

pub fn set_filename(&self, filename: impl Into<GodotString>)

pub fn set_name(&self, name: impl Into<GodotString>)

pub fn set_network_master(&self, id: i64, recursive: bool)

pub fn set_owner(&self, owner: impl AsArg<Node>)

pub fn set_pause_mode(&self, mode: i64)

pub fn set_physics_process(&self, enable: bool)

pub fn set_physics_process_internal(&self, enable: bool)

pub fn set_process(&self, enable: bool)

pub fn set_process_input(&self, enable: bool)

pub fn set_process_internal(&self, enable: bool)

pub fn set_process_priority(&self, priority: i64)

pub fn set_process_unhandled_input(&self, enable: bool)

pub fn set_process_unhandled_key_input(&self, enable: bool)

pub fn set_scene_instance_load_placeholder(&self, load_placeholder: bool)

pub fn update_configuration_warning(&self)

Trait Implementations

impl Debug for Timer

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>

Formats the value using the given formatter.

impl Deref for Timer

type Target = Node

The resulting type after dereferencing.

fn deref(&self) -> &Node

Dereferences the value.

impl DerefMut for Timer

fn deref_mut(&mut self) -> &mut Node

Mutably dereferences the value.

impl GodotObject for Timer

type RefKind = ManuallyManaged

The memory management kind of this type. This modifies the behavior of the Ref smart pointer. See its type-level documentation for more information.

fn class_name() -> &'static str

fn null() -> Null<Self>

Creates an explicitly null reference of Self as a method argument. This makes type inference easier for the compiler compared to Option.

fn new() -> Ref<Self, Unique> where
    Self: Instanciable, 

Creates a new instance of Self using a zero-argument constructor, as a Unique reference.

fn cast<T>(&self) -> Option<&T> where
    T: GodotObject + SubClass<Self>, 

Performs a dynamic reference downcast to target type.

fn upcast<T>(&self) -> &T where
    Self: SubClass<T>,
    T: GodotObject, 

Performs a static reference upcast to a supertype that is guaranteed to be valid.

unsafe fn assume_shared(&self) -> Ref<Self, Shared>

Creates a persistent reference to the same Godot object with shared thread access.

unsafe fn assume_thread_local(&self) -> Ref<Self, ThreadLocal> where
    Self: GodotObject<RefKind = RefCounted>, 

Creates a persistent reference to the same Godot object with thread-local thread access.

unsafe fn assume_unique(&self) -> Ref<Self, Unique>

Creates a persistent reference to the same Godot object with unique access.

impl Instanciable for Timer

fn construct() -> Ref<Timer, Unique>

impl QueueFree for Timer

unsafe fn godot_queue_free(obj: *mut c_void)

impl SubClass<Node> for Timer

impl SubClass<Object> for Timer