Struct SigLinkReached

pub struct SigLinkReached<'c> { /* private fields */ }

Implementations

impl<'c> SigLinkReached<'c>

pub fn emit(&mut self, details: Dictionary)

Methods from Deref<Target = TypedSignal<'c, NavigationAgent2D, (Dictionary,)>>

pub fn emit_tuple(&mut self, args: Ps)

Emit the signal with the given parameters.

This is intended for generic use. Typically, you’ll want to use the more specific emit() method of the code-generated signal type, which also has named parameters.

pub fn connect<F>(&mut self, function: F)

where F: SignalReceiver<(), Ps>,

Connect a non-member function (global function, associated function or closure).

Example usages:

sig.connect(Self::static_func);
sig.connect(global_func);
sig.connect(|arg| { /* closure */ });

To connect to a method of the own object self, use connect_self().
If you need cross-thread signals or connect flags, use connect_builder().

pub fn connect_obj<F, OtherC>(&mut self, object: &Gd<OtherC>, function: F)

where OtherC: GodotClass<Declarer = DeclUser> + Bounds, F: for<'c_rcv> SignalReceiver<&'c_rcv mut OtherC, Ps>,

Connect a method (member function) with any Gd<T> (not self) as the first parameter.

To connect to methods on the same object that declares the #[signal], use connect_self().
If you need cross-thread signals or connect flags, use connect_builder().

pub fn connect_builder(&mut self) -> ConnectBuilder<'_, 'c, C, (), Ps, ()>

Fully customizable connection setup.

The returned builder provides several methods to configure how to connect the signal. It needs to be finalized with a call to ConnectBuilder::done().

pub fn connect_self<F>(&mut self, function: F)

where F: for<'c_rcv> SignalReceiver<&'c_rcv mut C, Ps>,

Connect a method (member function) with &mut self as the first parameter.

To connect to methods on other objects, use connect_obj().
If you need a &self receiver, cross-thread signals or connect flags, use connect_builder().

pub fn to_fallible_future(&self) -> FallibleSignalFuture<R>

Creates a fallible future for this signal.

The future will resolve the next time the signal is emitted. See FallibleSignalFuture for details.

pub fn to_future(&self) -> SignalFuture<R>

Creates a future for this signal.

The future will resolve the next time the signal is emitted, but might panic if the signal object is freed. See SignalFuture for details.

Trait Implementations

impl<'c> Deref for SigLinkReached<'c>

type Target = TypedSignal<'c, NavigationAgent2D, (Dictionary,)>

The resulting type after dereferencing.

fn deref(&self) -> &<SigLinkReached<'c> as Deref>::Target

Dereferences the value.

impl DerefMut for SigLinkReached<'_>

fn deref_mut(&mut self) -> &mut <SigLinkReached<'_> as Deref>::Target

Mutably dereferences the value.