Struct Time
#[repr(C)]pub struct Time { /* private fields */ }Expand description
Godot class Time.
Inherits Object.
Related symbols:
See also Godot docs for Time.
§Singleton
This class is a singleton. You can get the one instance using Time::singleton().
Implementations§
§impl Time
impl Time
pub fn singleton() -> Gd<Time>
pub fn get_datetime_dict_from_unix_time(&self, unix_time_val: i64) -> Dictionary
pub fn get_date_dict_from_unix_time(&self, unix_time_val: i64) -> Dictionary
pub fn get_time_dict_from_unix_time(&self, unix_time_val: i64) -> Dictionary
pub fn get_datetime_string_from_unix_time(&self, unix_time_val: i64) -> GString
pub fn get_datetime_string_from_unix_time(&self, unix_time_val: i64) -> GString
To set the default parameters, use Self::get_datetime_string_from_unix_time_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_datetime_string_from_unix_time_ex<'a>( &'a self, unix_time_val: i64, ) -> ExGetDatetimeStringFromUnixTime<'a>
pub fn get_date_string_from_unix_time(&self, unix_time_val: i64) -> GString
pub fn get_time_string_from_unix_time(&self, unix_time_val: i64) -> GString
pub fn get_datetime_dict_from_datetime_string( &self, datetime: GString, weekday: bool, ) -> Dictionary
pub fn get_datetime_string_from_datetime_dict( &self, datetime: &Dictionary, use_space: bool, ) -> GString
pub fn get_unix_time_from_datetime_dict(&self, datetime: &Dictionary) -> i64
pub fn get_unix_time_from_datetime_string(&self, datetime: GString) -> i64
pub fn get_offset_string_from_offset_minutes( &self, offset_minutes: i64, ) -> GString
pub fn get_datetime_dict_from_system(&self) -> Dictionary
pub fn get_datetime_dict_from_system(&self) -> Dictionary
To set the default parameters, use Self::get_datetime_dict_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_datetime_dict_from_system_ex<'a>( &'a self, ) -> ExGetDatetimeDictFromSystem<'a>
pub fn get_date_dict_from_system(&self) -> Dictionary
pub fn get_date_dict_from_system(&self) -> Dictionary
To set the default parameters, use Self::get_date_dict_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_date_dict_from_system_ex<'a>(&'a self) -> ExGetDateDictFromSystem<'a>
pub fn get_time_dict_from_system(&self) -> Dictionary
pub fn get_time_dict_from_system(&self) -> Dictionary
To set the default parameters, use Self::get_time_dict_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_time_dict_from_system_ex<'a>(&'a self) -> ExGetTimeDictFromSystem<'a>
pub fn get_datetime_string_from_system(&self) -> GString
pub fn get_datetime_string_from_system(&self) -> GString
To set the default parameters, use Self::get_datetime_string_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_datetime_string_from_system_ex<'a>( &'a self, ) -> ExGetDatetimeStringFromSystem<'a>
pub fn get_date_string_from_system(&self) -> GString
pub fn get_date_string_from_system(&self) -> GString
To set the default parameters, use Self::get_date_string_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_date_string_from_system_ex<'a>( &'a self, ) -> ExGetDateStringFromSystem<'a>
pub fn get_time_string_from_system(&self) -> GString
pub fn get_time_string_from_system(&self) -> GString
To set the default parameters, use Self::get_time_string_from_system_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_time_string_from_system_ex<'a>( &'a self, ) -> ExGetTimeStringFromSystem<'a>
pub fn get_time_zone_from_system(&self) -> Dictionary
pub fn get_unix_time_from_system(&self) -> f64
pub fn get_ticks_msec(&self) -> u64
pub fn get_ticks_usec(&self) -> u64
Methods from Deref<Target = Object>§
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: GString) -> bool
pub fn set(&mut self, property: StringName, value: &Variant)
pub fn get(&self, property: StringName) -> Variant
pub fn set_indexed(&mut self, property_path: NodePath, value: &Variant)
pub fn get_indexed(&self, property_path: NodePath) -> Variant
pub fn get_property_list(&self) -> Array<Dictionary>
pub fn get_method_list(&self) -> Array<Dictionary>
pub fn property_can_revert(&self, property: StringName) -> bool
pub fn property_get_revert(&self, property: StringName) -> Variant
pub fn set_script(&mut self, script: &Variant)
pub fn get_script(&self) -> Variant
pub fn set_meta(&mut self, name: StringName, value: &Variant)
pub fn remove_meta(&mut self, name: StringName)
pub fn get_meta(&self, name: StringName) -> Variant
pub fn get_meta(&self, name: StringName) -> Variant
To set the default parameters, use Self::get_meta_ex and its builder methods. See the book for detailed usage instructions.
pub fn get_meta_ex<'a>(&'a self, name: StringName) -> ExGetMeta<'a>
pub fn has_meta(&self, name: StringName) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: GString)
pub fn add_user_signal(&mut self, signal: GString)
To set the default parameters, use Self::add_user_signal_ex and its builder methods. See the book for detailed usage instructions.
pub fn add_user_signal_ex<'a>( &'a mut self, signal: GString, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: StringName) -> bool
pub fn remove_user_signal(&mut self, signal: StringName)
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
pub fn emit_signal(&mut self, signal: StringName, varargs: &[Variant]) -> Error
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_emit_signal(
&mut self,
signal: StringName,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: StringName, varargs: &[Variant], ) -> Result<Error, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
pub fn call(&mut self, method: StringName, varargs: &[Variant]) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_call(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Variant
§Panics
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will panic in such a case.
pub fn try_call_deferred(
&mut self,
method: StringName,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: StringName, varargs: &[Variant], ) -> Result<Variant, CallError>
§Return type
This is a varcall method, meaning parameters and return values are passed as Variant.
It can detect call failures and will return Err in such a case.
pub fn set_deferred(&mut self, property: StringName, value: &Variant)
pub fn callv( &mut self, method: StringName, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: StringName) -> bool
pub fn get_method_argument_count(&self, method: StringName) -> i32
pub fn has_signal(&self, signal: StringName) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: StringName, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
pub fn connect(&mut self, signal: StringName, callable: Callable) -> Error
To set the default parameters, use Self::connect_ex and its builder methods. See the book for detailed usage instructions.
pub fn connect_ex<'a>( &'a mut self, signal: StringName, callable: Callable, ) -> ExConnect<'a>
pub fn disconnect(&mut self, signal: StringName, callable: Callable)
pub fn is_connected(&self, signal: StringName, callable: Callable) -> bool
pub fn set_block_signals(&mut self, enable: bool)
pub fn is_blocking_signals(&self) -> bool
pub fn notify_property_list_changed(&mut self)
pub fn set_message_translation(&mut self, enable: bool)
pub fn can_translate_messages(&self) -> bool
pub fn tr(&self, message: StringName) -> GString
pub fn tr(&self, message: StringName) -> GString
To set the default parameters, use Self::tr_ex and its builder methods. See the book for detailed usage instructions.
pub fn tr_ex<'a>(&'a self, message: StringName) -> ExTr<'a>
pub fn tr_n(
&self,
message: StringName,
plural_message: StringName,
n: i32,
) -> GString
pub fn tr_n( &self, message: StringName, plural_message: StringName, n: i32, ) -> GString
To set the default parameters, use Self::tr_n_ex and its builder methods. See the book for detailed usage instructions.
pub fn tr_n_ex<'a>( &'a self, message: StringName, plural_message: StringName, n: i32, ) -> ExTrN<'a>
pub fn is_queued_for_deletion(&self) -> bool
pub fn cancel_free(&mut self)
pub fn notify(&mut self, what: ObjectNotification)
pub fn notify(&mut self, what: ObjectNotification)
⚠️ Sends a Godot notification to all classes inherited by the object.
Triggers calls to on_notification(), and depending on the notification, also to Godot’s lifecycle callbacks such as ready().
Starts from the highest ancestor (the Object class) and goes down the hierarchy.
See also Godot docs for Object::notification().
§Panics
If you call this method on a user-defined object while holding a GdRef or GdMut guard on the instance, you will encounter
a panic. The reason is that the receiving virtual method on_notification() acquires a GdMut lock dynamically, which must
be exclusive.
pub fn notify_reversed(&mut self, what: ObjectNotification)
pub fn notify_reversed(&mut self, what: ObjectNotification)
⚠️ Like Self::notify(), but starts at the most-derived class and goes up the hierarchy.
See docs of that method, including the panics.