Tux emits bubbles while being underwater #3014

bruhmoent · 2024-07-13T09:42:42Z

This pr adds a visual effect - when Tux is underwater, he will emit bubble particles that will follow a sine pattern until they reach the water surface.

Make sure to test.

Brockengespenst · 2024-07-13T14:16:16Z

I think this is a pretty nice feature, but is it possible that the air_bubble-*.png files are missing?
Maybe some idea: What about using std::array for m_bubble_particles? This would make it easier to iterate over the array or do a check for bounds (e.g. when picking a random bubble).

bruhmoent · 2024-07-13T14:27:46Z

Oh you're right, I forgot to push the bubbles.

Brockengespenst · 2024-07-13T15:32:16Z

Looks pretty nice so far. Some comments from my side:

Sometimes it seems the bubbles are not emitted at the correct place after Tux has turned around. That looks a bit weird when the bubbles are emitted at the wrong side of Tux ;-)
I am not sure if the bubbles should really leave the water and vanish in the air. Probably they should start to vanish a bit earlier

bruhmoent · 2024-07-13T15:33:56Z

I like the effect of them "popping" in the air. And for the bubbles not being emitted at the right place, I'm aware - but I don't know what to do about it - sometimes the sprite rotation gets registered improperly - At-least that's what I've observed.

Brockengespenst · 2024-07-13T17:32:54Z

Some suggestions:

Use m_swimming_angle as it is already in radians
I do not fully understand your direction check. If comparing the angle in radians, I thinks something like m_swimming_angle > M_PI_2 && m_swimming_angle < M_PI_2 * 3.0 should check if Tux is facing left, all other cases Tux is facing right
If the beak was at Tux.height / 2, there would even be no need to check for direction, just rotate it. But if doing so in this case, this might lead to a small offset, maybe you can check if this looks still OK
I would not use std::vector for m_active_bubbles as it might lead to lots of copy operations when deleting entries as vector must guarantee that all entries are placed in a linear order on the heap. When deleting items in the middle, they have to be copied to a new place in linear order. As you do not need to access the bubles by index, you could simply use a std::list or similar

bruhmoent · 2024-07-13T18:13:06Z

Thanks for the suggestions!

Brockengespenst · 2024-07-13T21:13:23Z

No problem. I really like this feature, but I think there are two small tweaks to be done:

I guess small and big Tux need to be handled differently. Small Tux swimming left looks good, but when small Tux swims right, there is a bit of space between the beak and the point where bubbles are emitted
Also, kind of related probably, left and right direction of Tux seem to need different offsets. Big Tux swimming right emits bubbles direcly at his beak, but big Tux swimming left emits the bubbles somwhere "behind his head"

It would be great if you could have a look at these two things.

tobbi

Approve on account of code style. Haven't done any actual testing in-game, though.

Rusty-Box · 2024-07-14T21:07:37Z

@bruhmoent Why did you not use the .sprite file I send you?

Rusty-Box · 2024-07-14T21:08:39Z

Also, I think the bubbles vertical speed could be increased by quite a bit

bruhmoent · 2024-07-14T21:15:56Z

@bruhmoent Why did you not use the .sprite file I send you?

I just used the images - I found the .sprite file to be unnecessary? Idk how does it matter really

MatusGuy

Replace all glm::vec2s with Vectors

Despite what I mentioned. It looks great! Thanks for your contribution!

MatusGuy · 2024-07-14T21:05:44Z

src/object/player.cpp

+ glm::vec2 beak_position;
+
+ // Determine direction based on the radians
+ if (m_swimming_angle > static_cast<float>(M_PI_2) && m_swimming_angle < 3.0f * static_cast<float>(M_PI_2)) // Facing left


We use math::PI_2

Suggested change

if (m_swimming_angle > static_cast<float>(M_PI_2) && m_swimming_angle < 3.0f * static_cast<float>(M_PI_2)) // Facing left

if (m_swimming_angle > static_cast<float>(math::PI_2)) && m_swimming_angle < 3.0f * static_cast<float>(math::PI_2)) // Facing left

MatusGuy · 2024-07-14T21:08:10Z

src/object/player.cpp

+ m_bubble_particles[1] = Surface::from_file("images/particles/air_bubble-2.png");
+ m_bubble_particles[2] = Surface::from_file("images/particles/air_bubble-3.png");
+ m_bubble_particles[3] = Surface::from_file("images/particles/air_bubble-4.png");
+ m_bubble_timer.start(3.0f + (rand() % 2));


For usage of rng in graphics effects, use graphicsRandom

Suggested change

m_bubble_timer.start(3.0f + (rand() % 2));

m_bubble_timer.start(3.0f + graphicsRandom.randf(2));

src/object/player.hpp

MatusGuy · 2024-07-14T21:12:24Z

src/object/player.cpp

+ SurfacePtr bubble_surface = m_bubble_particles[random_index];
+
+ glm::vec2 bubble_pos;
+ if (m_swimming_angle > static_cast<float>(M_PI_2) && m_swimming_angle < 3.0f * static_cast<float>(M_PI_2)) // Facing left


Suggested change

if (m_swimming_angle > static_cast<float>(M_PI_2) && m_swimming_angle < 3.0f * static_cast<float>(M_PI_2)) // Facing left

if (m_swimming_angle > static_cast<float>(math::PI_2) && m_swimming_angle < 3.0f * static_cast<float>(math::PI_2)) // Facing left

MatusGuy · 2024-07-14T21:15:36Z

src/object/player.cpp

+ m_bubble_particles[0] = Surface::from_file("images/particles/air_bubble-1.png");
+ m_bubble_particles[1] = Surface::from_file("images/particles/air_bubble-2.png");
+ m_bubble_particles[2] = Surface::from_file("images/particles/air_bubble-3.png");
+ m_bubble_particles[3] = Surface::from_file("images/particles/air_bubble-4.png");


Apparently rusty sent you a sprite file? Use this in junction with the get_actions method

Brockengespenst · 2024-07-14T22:40:15Z

Sorry, but I have to slightly update my suggestion regarding how to determine the direction. From the swim sprite logic, I saw that the following code is used:
std::abs(m_swimming_angle) <= math::PI_2 ? Direction::RIGHT : Direction::LEFT
This seems to work more reliable, because it takes also negative angles into account.

MatusGuy

Code looks good, will test later

Brockengespenst · 2024-07-16T18:12:42Z

src/object/player.cpp

+ Vector beak_position;
+
+ // Determine direction based on the radians
+ if (m_swimming_angle > static_cast<float>(math::PI_2) && m_swimming_angle < 3.0f * static_cast<float>(math::PI_2)) // Facing left


Could you please change the check to std::abs(m_swimming_angle) <= math::PI_2? This is used here in Player.cpp already, so the code would be consistent. Remember, that this condition checks for swimming right, so your conditional code must be swapped.

Brockengespenst · 2024-07-16T18:13:00Z

src/object/player.cpp

+ SurfacePtr bubble_surface = surfaces.at(random_index);
+
+ Vector bubble_pos(0.f, 0.f);
+ if (m_swimming_angle > static_cast<float>(math::PI_2) && m_swimming_angle < 3.0f * static_cast<float>(math::PI_2)) // Facing left


Could you please change the check to std::abs(m_swimming_angle) <= math::PI_2? This is used here in Player.cpp already, so the code would be consistent. Remember, that this condition checks for swimming right, so your conditional code must be swapped.

Brockengespenst

There is just this one include, that is obsolete again. Rest looks fine, thanks for adapting the left/right check.

Brockengespenst · 2024-07-17T21:13:48Z

src/object/player.hpp

@@ -28,6 +28,9 @@
 #include "video/layer.hpp"
 #include "video/surface_ptr.hpp"

+#include <array>


This include is not needed anymore.

Brockengespenst

Looks fine to me.

mstoeckl · 2024-07-20T23:12:10Z

While this looks nice and cartoony, I (random passerby) should warn that cartoons are often wrong, and actual penguins probably don't breathe out underwater. (Nor should any species that can't breathe in underwater, except if very close to the surface :-)

Instead of emitting periodic bubbles from their beaks, penguins might produce them through:

splashing near water surface
possible: some bubbles when opening beak underwater to grab things for the first time
releasing trapped air after diving in (looks like many small trailing bubbles from the back/wings of penguin; could take some time for all bubbles to go.)

Therefore: I would suggest emitting the bubbles more irregularly in space and time; from the main body instead of from the beak; and maybe progressively reduce the bubble rate the longer Tux stays underwater.

bruhmoent · 2024-07-20T23:15:27Z

SuperTux is not aimed to replicate realistic behaviours. This is just a little visual effect. This is out of scope for this PR - and this might be adjusted in the future.

mstoeckl · 2024-07-20T23:35:33Z

SuperTux is not aimed to replicate realistic behaviours. This is just a little visual effect. This is out of scope for this PR - and this might be adjusted in the future.

Agreed. While I think foundations in reality are nice to have, in the end art and gameplay are what matter.

MatusGuy

I can't confirm if the item in m_active_bubbles gets popped when the bubble goes offscreen, but make sure it does.

Almost there!

MatusGuy · 2024-07-21T13:21:59Z

src/object/player.cpp

+ bubble_pos.y += burst_offset_y;
+ }
+
+ m_active_bubbles.push_back({ bubble_surface, bubble_pos });


The bubble should not try to spawn if it's not submerged, or else it will spawn the bubble for one frame and then pop in the next frame. To reproduce this bug, get in this position.

MatusGuy · 2024-07-21T13:23:56Z

src/object/player.cpp

+ m_active_bubbles.remove_if([&](const std::pair<SurfacePtr, Vector>& bubble)
+ {
+ Rectf bubble_box(bubble.second.x, bubble.second.y, bubble.second.x + 16.f, bubble.second.y + 16.f);
+ bool is_out_of_water = Sector::get().is_free_of_tiles(bubble_box, true, Tile::WATER);


Make sure the bubble pops when hitting solid tiles.

Rusty-Box · 2024-08-03T01:05:27Z

The bubbles are still not animated despite the sprite file having 2 action of animation. One for bigger bubbles and one for smaller ones.

Add bubbles while being underwater

f5eea9b

bruhmoent force-pushed the bubbles branch from 56b0a4c to f5eea9b Compare July 13, 2024 10:05

Leftovers

cc9dbbb

bruhmoent and others added 3 commits July 13, 2024 16:29

Add bubble particles made by @rustybox [ci skip]

a7f5358

Fix a bug + Add a chance for multiple bubbles to spawn

369742a

Code style

6605fa6

bruhmoent force-pushed the bubbles branch from e9bd316 to 6605fa6 Compare July 13, 2024 18:35

bruhmoent and others added 2 commits July 13, 2024 20:37

Bug fixes + suggestions

d324f56

Fix builds

ec30ddb

Adjustments

913b087

tobbi approved these changes Jul 14, 2024

View reviewed changes

MatusGuy requested changes Jul 14, 2024

View reviewed changes

bruhmoent and others added 2 commits July 16, 2024 13:50

Use .sprite + code style fixes

bf3104b

Fix builds

2dd2afa

bruhmoent requested a review from MatusGuy July 16, 2024 12:31

MatusGuy reviewed Jul 16, 2024

View reviewed changes

Brockengespenst suggested changes Jul 16, 2024

View reviewed changes

Consistency

32e9108

bruhmoent requested a review from Brockengespenst July 17, 2024 18:38

bruhmoent requested a review from MatusGuy July 17, 2024 18:38

Brockengespenst suggested changes Jul 17, 2024

View reviewed changes

Unnecessary include

292959e

Brockengespenst approved these changes Jul 17, 2024

View reviewed changes

MatusGuy requested changes Jul 21, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Tux emits bubbles while being underwater #3014

Tux emits bubbles while being underwater #3014

bruhmoent commented Jul 13, 2024 •

edited

Loading

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024 •

edited

Loading

tobbi left a comment

Rusty-Box commented Jul 14, 2024

Rusty-Box commented Jul 14, 2024

bruhmoent commented Jul 14, 2024

MatusGuy left a comment

MatusGuy Jul 14, 2024

MatusGuy Jul 14, 2024

MatusGuy Jul 14, 2024

MatusGuy Jul 14, 2024

Brockengespenst commented Jul 14, 2024 •

edited

Loading

MatusGuy left a comment

Brockengespenst Jul 16, 2024

Brockengespenst Jul 16, 2024

Brockengespenst left a comment

Brockengespenst Jul 17, 2024

Brockengespenst left a comment •

edited

Loading

mstoeckl commented Jul 20, 2024

bruhmoent commented Jul 20, 2024

mstoeckl commented Jul 20, 2024

MatusGuy left a comment

MatusGuy Jul 21, 2024

MatusGuy Jul 21, 2024

Rusty-Box commented Aug 3, 2024

	if (m_swimming_angle > static_cast<float>(M_PI_2) && m_swimming_angle < 3.0f * static_cast<float>(M_PI_2)) // Facing left
	if (m_swimming_angle > static_cast<float>(math::PI_2)) && m_swimming_angle < 3.0f * static_cast<float>(math::PI_2)) // Facing left

	m_bubble_timer.start(3.0f + (rand() % 2));
	m_bubble_timer.start(3.0f + graphicsRandom.randf(2));

Tux emits bubbles while being underwater #3014

Are you sure you want to change the base?

Tux emits bubbles while being underwater #3014

Conversation

bruhmoent commented Jul 13, 2024 • edited Loading

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024

bruhmoent commented Jul 13, 2024

Brockengespenst commented Jul 13, 2024 • edited Loading

tobbi left a comment

Choose a reason for hiding this comment

Rusty-Box commented Jul 14, 2024

Rusty-Box commented Jul 14, 2024

bruhmoent commented Jul 14, 2024

MatusGuy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Brockengespenst commented Jul 14, 2024 • edited Loading

MatusGuy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Brockengespenst left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Brockengespenst left a comment • edited Loading

Choose a reason for hiding this comment

mstoeckl commented Jul 20, 2024

bruhmoent commented Jul 20, 2024

mstoeckl commented Jul 20, 2024

MatusGuy left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Rusty-Box commented Aug 3, 2024

bruhmoent commented Jul 13, 2024 •

edited

Loading

Brockengespenst commented Jul 13, 2024 •

edited

Loading

Brockengespenst commented Jul 14, 2024 •

edited

Loading

Brockengespenst left a comment •

edited

Loading