Signals now accept parameters

[LeaoLuciano]

Project for testing:

• dodge-the-creeps-signals.zip
• Added a signal named test in Player scene that is emitted when player dies
• This signal is connected in Main scene which calls test_function, printing player's death position

[Bromeon]

Thanks! 🙂

Can you show some usage examples here (so people don't have to download the archive)?

[LeaoLuciano]

player.rs:

    #[signal]
    fn test(direction: Vector2);

    fn on_player_body_entered(&mut self, _body: Gd<PhysicsBody2D>) {
        ...
        let pos = self.get_position();
        self.base.emit_signal("test".into(), &[pos.to_variant()]);
    }

main_scene.rs:

    #[func]
    pub fn new_game(&mut self) {
        ...
        let mut player = self.base.get_node_as::<player::Player>("Player");
        player.bind_mut().connect(
            "test".into(),
            Callable::from_object_method(self.base.get_node_as::<Self>("."), "test_function"),
            0,
        );
    }

    #[func]
    fn test_function(&self, direction: Vector2) {
        println!("Player died at: {}", direction);
    }

Gravacao.de.tela.de.2023-05-18.08-31-44.webm

[LeaoLuciano]

With 2 parameters:
player.rs:

    #[signal]
    fn test(direction: Vector2, distance: f32);


    #[func]
    fn on_player_body_entered(&mut self, _body: Gd<PhysicsBody2D>) {
        ...
        self.base.emit_signal("test".into(), &[pos.to_variant(), pos.length().to_variant()]);
    }

main_scene.rs:

    #[func]
    fn test_function(&self, direction: Vector2, distance: f32) {
        println!("Player died at: {} (distance {} from (0, 0))", direction, distance);
    }

Gravacao.de.tela.de.2023-05-18.08-39-44.webm

[Bromeon]

bors try

[GodotRust]

API docs are being generated and will be shortly available at: https://godot-rust.github.io/docs/gdext/pr-279

[bors]

try

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

• full-ci

[Bromeon]

Thanks a lot for the update! Added smaller comments. Since there is now quite a bit of signal functionality, you can also consider adding a new signal_test.rs file for these tests (don't forget license header). Or leave it as-is, if you prefer 🙂

Could you integrate your changes into the 2nd commit?

[Bromeon]

Suggested change

	emitter
	.share()
	.upcast::<Object>()
	.emit_signal(signal_name.into(), arg);
	emitter.base.emit_signal(signal_name.into(), arg);

It's in the same file and for a test, so encapsulation is not the highest priority.

[Bromeon]

Would be nice to check the preconditions first and separate them with an empty line from the logic.
Same above.

Suggested change

	self.used[2].set(true);
	assert_eq!(self.base.share(), arg1);
	assert_eq!(SIGNAL_ARG_STRING, arg2.to_string());
	assert_eq!(self.base.share(), arg1);
	assert_eq!(SIGNAL_ARG_STRING, arg2.to_string());
	self.used[2].set(true);

[Bromeon]

Suggested change

	let emitter: Gd<SignalEmitter> = Gd::new_default();
	let receiver: Gd<SignalReceiver> = Gd::new_default();
	let emitter = Gd::<SignalEmitter>::new_default();
	let receiver = Gd::<SignalReceiver>::new_default();

Turbofish! 🐟💨

[Bromeon]

Suggested change

	let signal_name = format!("signal_{}_arg", i);
	let receiver_name = format!("receive_{}_arg", i);
	let signal_name = format!("signal_{i}_arg");
	let receiver_name = format!("receive_{i}_arg");

[Bromeon]

Suggested change

	emitter.share().upcast::<Object>().connect(
	emitter.base.connect(

[Bromeon]

bors try

[bors]

try

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

• full-ci

[Bromeon]

Thanks a lot!

bors r+

[bors]

Build succeeded!

The publicly hosted instance of bors-ng is deprecated and will go away soon.

If you want to self-host your own instance, instructions are here.
For more help, visit the forum.

If you want to switch to GitHub's built-in merge queue, visit their help page.

• full-ci