Struct EngineDebugger
#[repr(C)]pub struct EngineDebugger { /* private fields */ }
Expand description
Godot class EngineDebugger.
Inherits Object
.
Related symbols:
engine_debugger
: sidecar module with related enum/flag types
See also Godot docs for EngineDebugger
.
§Singleton
This class is a singleton. You can get the one instance using EngineDebugger::singleton()
.
§Final class
This class is final, meaning you cannot inherit from it, and it comes without I*
interface trait. It is still possible that other Godot classes inherit from it, but that is limited to the engine itself.
Implementations§
§impl EngineDebugger
impl EngineDebugger
pub fn singleton() -> Gd<EngineDebugger>
pub fn is_active(&mut self) -> bool
pub fn register_profiler( &mut self, name: impl AsArg<StringName>, profiler: impl AsArg<Option<Gd<EngineProfiler>>>, )
pub fn unregister_profiler(&mut self, name: impl AsArg<StringName>)
pub fn is_profiling(&mut self, name: impl AsArg<StringName>) -> bool
pub fn has_profiler(&mut self, name: impl AsArg<StringName>) -> bool
pub fn profiler_add_frame_data( &mut self, name: impl AsArg<StringName>, data: &Array<Variant>, )
pub fn profiler_enable(&mut self, name: impl AsArg<StringName>, enable: bool)
pub fn profiler_enable(&mut self, name: impl AsArg<StringName>, enable: bool)
To set the default parameters, use Self::profiler_enable_ex
and its builder methods. See the book for detailed usage instructions.
pub fn profiler_enable_ex<'a>( &'a mut self, name: impl AsArg<StringName> + 'a, enable: bool, ) -> ExProfilerEnable<'a>
pub fn register_message_capture( &mut self, name: impl AsArg<StringName>, callable: &Callable, )
pub fn unregister_message_capture(&mut self, name: impl AsArg<StringName>)
pub fn has_capture(&mut self, name: impl AsArg<StringName>) -> bool
pub fn line_poll(&mut self)
pub fn send_message( &mut self, message: impl AsArg<GString>, data: &Array<Variant>, )
pub fn debug(&mut self)
pub fn debug(&mut self)
To set the default parameters, use Self::debug_ex
and its builder methods. See the book for detailed usage instructions.
pub fn debug_ex<'a>(&'a mut self) -> ExDebug<'a>
pub fn script_debug(&mut self, language: impl AsArg<Option<Gd<ScriptLanguage>>>)
pub fn script_debug(&mut self, language: impl AsArg<Option<Gd<ScriptLanguage>>>)
To set the default parameters, use Self::script_debug_ex
and its builder methods. See the book for detailed usage instructions.
pub fn script_debug_ex<'a>( &'a mut self, language: impl AsArg<Option<Gd<ScriptLanguage>>> + 'a, ) -> ExScriptDebug<'a>
pub fn set_lines_left(&mut self, lines: i32)
pub fn get_lines_left(&self) -> i32
pub fn set_depth(&mut self, depth: i32)
pub fn get_depth(&self) -> i32
pub fn is_breakpoint(&self, line: i32, source: impl AsArg<StringName>) -> bool
pub fn is_skipping_breakpoints(&self) -> bool
pub fn insert_breakpoint(&mut self, line: i32, source: impl AsArg<StringName>)
pub fn remove_breakpoint(&mut self, line: i32, source: impl AsArg<StringName>)
pub fn clear_breakpoints(&mut self)
Methods from Deref<Target = Object>§
pub fn get_script(&self) -> Option<Gd<Script>>
pub fn set_script(&mut self, script: impl AsArg<Option<Gd<Script>>>)
pub fn connect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, ) -> Error
pub fn connect_flags( &mut self, signal: impl AsArg<StringName>, callable: &Callable, flags: ConnectFlags, ) -> Error
pub fn get_class(&self) -> GString
pub fn is_class(&self, class: impl AsArg<GString>) -> bool
pub fn set(&mut self, property: impl AsArg<StringName>, value: &Variant)
pub fn get(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_indexed( &mut self, property_path: impl AsArg<NodePath>, value: &Variant, )
pub fn get_indexed(&self, property_path: impl AsArg<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: impl AsArg<StringName>) -> bool
pub fn property_get_revert(&self, property: impl AsArg<StringName>) -> Variant
pub fn set_meta(&mut self, name: impl AsArg<StringName>, value: &Variant)
pub fn remove_meta(&mut self, name: impl AsArg<StringName>)
pub fn get_meta(&self, name: impl AsArg<StringName>) -> Variant
pub fn get_meta(&self, name: impl AsArg<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: impl AsArg<StringName> + 'a, ) -> ExGetMeta<'a>
pub fn has_meta(&self, name: impl AsArg<StringName>) -> bool
pub fn get_meta_list(&self) -> Array<StringName>
pub fn add_user_signal(&mut self, signal: impl AsArg<GString>)
pub fn add_user_signal(&mut self, signal: impl AsArg<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: impl AsArg<GString> + 'a, ) -> ExAddUserSignal<'a>
pub fn has_user_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn remove_user_signal(&mut self, signal: impl AsArg<StringName>)
pub fn emit_signal(
&mut self,
signal: impl AsArg<StringName>,
varargs: &[Variant],
) -> Error
pub fn emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Error, CallError>
pub fn try_emit_signal( &mut self, signal: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Variant
pub fn call_deferred( &mut self, method: impl AsArg<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: impl AsArg<StringName>,
varargs: &[Variant],
) -> Result<Variant, CallError>
pub fn try_call_deferred( &mut self, method: impl AsArg<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: impl AsArg<StringName>, value: &Variant, )
pub fn callv( &mut self, method: impl AsArg<StringName>, arg_array: &Array<Variant>, ) -> Variant
pub fn has_method(&self, method: impl AsArg<StringName>) -> bool
pub fn get_method_argument_count(&self, method: impl AsArg<StringName>) -> i32
pub fn has_signal(&self, signal: impl AsArg<StringName>) -> bool
pub fn get_signal_list(&self) -> Array<Dictionary>
pub fn get_signal_connection_list( &self, signal: impl AsArg<StringName>, ) -> Array<Dictionary>
pub fn get_incoming_connections(&self) -> Array<Dictionary>
pub fn disconnect( &mut self, signal: impl AsArg<StringName>, callable: &Callable, )
pub fn is_connected( &self, signal: impl AsArg<StringName>, callable: &Callable, ) -> bool
pub fn has_connections(&self, signal: impl AsArg<StringName>) -> 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: impl AsArg<StringName>) -> GString
pub fn tr(&self, message: impl AsArg<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: impl AsArg<StringName> + 'a) -> ExTr<'a>
pub fn tr_n(
&self,
message: impl AsArg<StringName>,
plural_message: impl AsArg<StringName>,
n: i32,
) -> GString
pub fn tr_n( &self, message: impl AsArg<StringName>, plural_message: impl AsArg<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: impl AsArg<StringName> + 'a, plural_message: impl AsArg<StringName> + 'a, n: i32, ) -> ExTrN<'a>
pub fn get_translation_domain(&self) -> StringName
pub fn set_translation_domain(&mut self, domain: impl AsArg<StringName>)
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.
Trait Implementations§
§impl Bounds for EngineDebugger
impl Bounds for EngineDebugger
§impl Debug for EngineDebugger
impl Debug for EngineDebugger
§impl Deref for EngineDebugger
impl Deref for EngineDebugger
§impl DerefMut for EngineDebugger
impl DerefMut for EngineDebugger
§fn deref_mut(&mut self) -> &mut <EngineDebugger as Deref>::Target
fn deref_mut(&mut self) -> &mut <EngineDebugger as Deref>::Target
§impl GodotClass for EngineDebugger
impl GodotClass for EngineDebugger
§const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
const INIT_LEVEL: InitLevel = crate::init::InitLevel::Scene
§fn class_id() -> ClassId
fn class_id() -> ClassId
§fn class_name() -> ClassId
fn class_name() -> ClassId
class_id()
§fn inherits<Base>() -> boolwhere
Base: GodotClass,
fn inherits<Base>() -> boolwhere
Base: GodotClass,
§impl Inherits<Object> for EngineDebugger
impl Inherits<Object> for EngineDebugger
§const IS_SAME_CLASS: bool = false
const IS_SAME_CLASS: bool = false
Self == Base
. Read more§impl WithSignals for EngineDebugger
impl WithSignals for EngineDebugger
§type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
type SignalCollection<'c, C: WithSignals> = SignalsOfObject<'c, C>
Auto Trait Implementations§
impl Freeze for EngineDebugger
impl RefUnwindSafe for EngineDebugger
impl !Send for EngineDebugger
impl !Sync for EngineDebugger
impl Unpin for EngineDebugger
impl UnwindSafe for EngineDebugger
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
§impl<T> Inherits<T> for Twhere
T: GodotClass,
impl<T> Inherits<T> for Twhere
T: GodotClass,
§const IS_SAME_CLASS: bool = true
const IS_SAME_CLASS: bool = true
Self == Base
. Read more