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
IEngineDebugger: virtual methods

§Singleton

This class is a singleton. You can get the one instance using EngineDebugger::singleton().

Implementations§

§

impl EngineDebugger

pub fn singleton() -> Gd<EngineDebugger>

pub fn is_active(&mut self) -> bool

pub fn register_profiler( &mut self, name: StringName, profiler: impl AsObjectArg<EngineProfiler>, )

pub fn unregister_profiler(&mut self, name: StringName)

pub fn is_profiling(&mut self, name: StringName) -> bool

pub fn has_profiler(&mut self, name: StringName) -> bool

pub fn profiler_add_frame_data( &mut self, name: StringName, data: &Array<Variant>, )

pub fn profiler_enable(&mut self, name: 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: StringName, enable: bool, ) -> ExProfilerEnable<'a>

pub fn register_message_capture(&mut self, name: StringName, callable: Callable)

pub fn unregister_message_capture(&mut self, name: StringName)

pub fn has_capture(&mut self, name: StringName) -> bool

pub fn line_poll(&mut self)

pub fn send_message(&mut self, message: GString, data: &Array<Variant>)

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 AsObjectArg<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 AsObjectArg<ScriptLanguage>, ) -> 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: StringName) -> bool

pub fn is_skipping_breakpoints(&self) -> bool

pub fn insert_breakpoint(&mut self, line: i32, source: StringName)

pub fn remove_breakpoint(&mut self, line: i32, source: StringName)

pub fn clear_breakpoints(&mut self)

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

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)

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

§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>

§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

§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>

§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

§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>

§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

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

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

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)

⚠️ 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.