Linked sprite support, custom `MovingSprite` light sprites #2753

Vankata453 · 2024-01-30T14:57:54Z

Custom light sprites can now be added to all objects, which inherit MovingSprite. Setting a custom color for the light sprite is also possible, as long as the object is not designed to use foreign color values (for example, from an option).

To add a light sprite with an RGB color of 0.5, 0.2, 0.25, in a .sprite file:

(linked-sprites
  (light "path/to/light/sprite" 0.5 0.2 0.25)
)

Keep in mind that specifying color values is optional. The entry can also end after specifying the file.

Additionally:

Objects which utilize more than 1 sprite are now able to get the files of their additional sprites from the main one's linked-sprites list (the same block where light sprites can also be added, as shown above). This allows for expanded sprite customization for objects.

To add linked sprites, in a .sprite file:

(linked-sprites
  (key "path/to/sprite")
  (key2 "another/sprite/file")
)

Linked sprites can be added under sprite actions, too. If a sprite with the same key is found in the general linked sprites block and the action-specific one, the sprite specified by the action will be prioritized, thus overriding the default linked sprite file.

Sprites, which the specific object does not support, will be ignored.

Sprite actions now support the flip-offset property, which determines how much the sprite should be vertically offset when flipped vertically.

Objects which utilize more than 1 sprite now get the files of their additional sprites from the main one's "linked-sprites" list. This allows for expanded sprite customization for objects.

Custom lightsprites can now be added to all objects, which inherit `MovingSprite`. Setting a custom color for the lightsprite is also possible, as long as the object is not designed to use foreign color values (for example, from an option).

[ci skip]

Rusty-Box · 2024-01-30T16:53:54Z

Do the light sprites work per action or is it one for all?

Vankata453 · 2024-01-30T16:59:53Z

Do the light sprites work per action or is it one for all?

One for all, currently. I think per-action could be done, though.

Rusty-Box · 2024-01-30T17:03:41Z

One for all, currently. I think per-action could be done, though.

That would be nice to have for sure

Vankata453 · 2024-01-30T17:08:50Z

One for all, currently. I think per-action could be done, though.

I'm thinking it could be done by having the same block available in action, and if a sprite with the same key as in the global block is available, then prioritize the one of the action.

Linked sprites can now be added to sprite actions too. If a sprite with the same key is found in the general linked sprites block and the action-specific one, the sprite specified by the action will be prioritized, thus overriding the default linked sprite file.

MatusGuy · 2024-03-13T19:34:06Z

What was this trying to fix?

Vankata453 · 2024-03-13T19:36:40Z

What was this trying to fix?

Hardcoded sprites.

Rusty-Box · 2024-03-13T20:05:33Z

@Vankata453 My brain explodes by trying to form this words so I'll do it like this. Can I:

Make a light .sprite file with 2+ actions
Link that .sprite file to the object's .sprite file
Assign individual actions of light sprite to each action of the object .sprite if needed

The way I originally was hoping we could achieve that was through a special tag within an action.
Here is an example Dive Mine.sprite file using the theoretical ([key name]-action "[action name]") tag:

 (action
  (name "left")
  (fps 12.0)
  (hitbox 14 19 32 32)
  (ticking-glow-action "idle")
  (images "left-0.png"
          "left-1.png"
          "left-2.png"
          "left-3.png"
		  "left-4.png"
		  "left-5.png"
		  "left-6.png"
		  "left-7.png"
		  "left-8.png"
		  "left-9.png"
		  "left-10.png"
		  "left-11.png"))

 (action
  (name "right")
  (fps 12.0)
  (hitbox 14 19 32 32)
  (ticking-glow-action "idle")
  (mirror-action "left"))
 
 (action
  (name "iced-left")
  (hitbox 5 8 32 32)
  (ticking-glow-action "idle")
  (images "left-0.png"))
 
 (action
  (name "iced-right")
  (hitbox 5 8 32 32)
  (ticking-glow-action "idle")
  (mirror-action "iced-left"))

 (action
  (name "ticking-left")
  (fps 15.0)
  (hitbox 14 19 32 32)
  (ticking-glow-action "ticking")
  (images "ticking-0.png"
          "ticking-1.png"
          "ticking-2.png"
          "ticking-3.png"
          "ticking-4.png"
		  "ticking-5.png"
		  "ticking-6.png"
		  "ticking-7.png"
		  "ticking-8.png"
		  "ticking-9.png"))

 
 (action
  (name "ticking-right")
  (fps 15.0)
  (hitbox 14 19 32 32)
  (ticking-glow-action "ticking")
  (mirror-action "ticking-left"))

  (linked-sprites
    (ticking-glow "images/creatures/dive_mine/ticking_glow/ticking_glow.sprite")
  )
)

The way the tag would work is that it will check for action names within the linked sprite file (in this case dive_mine/ticking_glow/ticking_glow.sprite), i.e. "idle" and "ticking".

Vankata453 · 2024-03-13T20:16:34Z

@Rusty-Box Action-specific linked-sprites are already supported, so what I believe only needs to be done to support this is to be able to link sprites with custom default actions.

I modified your example, so by default it globally (for all actions) links the ticking-glow sprite with the action idle (since most actions seem to use it). Since only the last two actions use the ticking action from the sprite, it's declared again in a new linked-sprites block inside of them, with the same name (thus it will override the global ticking-glow linked sprite, which has the idle action).

At the end, the modified example looks like this:

 (action
  (name "left")
  (fps 12.0)
  (hitbox 14 19 32 32)
  (images "left-0.png"
          "left-1.png"
          "left-2.png"
          "left-3.png"
		  "left-4.png"
		  "left-5.png"
		  "left-6.png"
		  "left-7.png"
		  "left-8.png"
		  "left-9.png"
		  "left-10.png"
		  "left-11.png"))

 (action
  (name "right")
  (fps 12.0)
  (hitbox 14 19 32 32)
  (mirror-action "left"))
 
 (action
  (name "iced-left")
  (hitbox 5 8 32 32)
  (images "left-0.png"))
 
 (action
  (name "iced-right")
  (hitbox 5 8 32 32)
  (mirror-action "iced-left"))

 (action
  (name "ticking-left")
  (fps 15.0)
  (hitbox 14 19 32 32)
  (linked-sprites
    (ticking-glow "images/creatures/dive_mine/ticking_glow/ticking_glow.sprite" "ticking")
  )
  (images "ticking-0.png"
          "ticking-1.png"
          "ticking-2.png"
          "ticking-3.png"
          "ticking-4.png"
		  "ticking-5.png"
		  "ticking-6.png"
		  "ticking-7.png"
		  "ticking-8.png"
		  "ticking-9.png"))

 
 (action
  (name "ticking-right")
  (fps 15.0)
  (hitbox 14 19 32 32)
  (linked-sprites
    (ticking-glow "images/creatures/dive_mine/ticking_glow/ticking_glow.sprite" "ticking")
  )
  (mirror-action "ticking-left"))

 (linked-sprites
   (ticking-glow "images/creatures/dive_mine/ticking_glow/ticking_glow.sprite" "idle")
 )

Rusty-Box · 2024-03-13T20:26:09Z

@Rusty-Box Action-specific linked-sprites are already supported, so what I believe only needs to be done to support this is to be able to link sprites with custom default actions.

Wait but Dive Mine's glow never changes. Rather is disappears when it should begins playing the ticking action, as of now. Is there just no way to define that right now? I'm so confused

Vankata453 · 2024-03-13T20:53:58Z

Wait but Dive Mine's glow never changes. Rather is disappears when it should begins playing the ticking action, as of now. Is there just no way to define that right now? I'm so confused

As I mentioned in the beginning, it still has to be done, I just offered a way it could work.

Rusty-Box · 2024-03-13T21:07:24Z

Okay. Good to know. I thought I was going crazy here 😅
In that case I guess my only note would be that I feel like my proposal looks a bit better in terms of readbilty and having to type less but I ain't a coder so I don't wanna pretend I know better. Atleast I know now that I wasn't crazy, so that's nice :]

Vankata453 · 2024-03-13T21:09:00Z

May be better in terms of readability, but would be more of a pain to implement. :D

(Oh, and this approach is also way more flexible, since you can also change the whole sprite, not just the action.)

…ites

Rusty-Box · 2024-06-18T17:33:10Z

Is it just me or is it not working? I updated Dive Mine's sprite file to look like you showed in this example here but it doesn't seem to work. The light keeps disapearing when you approach Dive Mine instead of changing the action of the linked sprite. Am I doing something wrong here?

Rusty-Box · 2024-06-18T17:35:51Z

Also the candle light doesn't seem to be rendered as a lightmap since you get a black box when you place it

Rusty-Box · 2024-09-08T16:07:50Z

@MatusGuy Why does Dart Traps light have numbers in its linked sprite and why (when I change it) it either crashes my game or doesn't show any glowing. Is it hardcoded? It should care what I put there, should it? Since this is were you set it up to how you please when it comes to naming. It works with Dive Mine seemingly and I tried a similar naming convention.

…ites

…`SpriteParticle`s

Rusty-Box · 2024-11-22T23:26:41Z

So there's missing sprites for the sparkle effect on keys and gold bomb uses the wrong glow path. It uses the same as Mr.Bomb but the image path looks for one in the gold bomb folder (obviously there's nothing there).

I'll test adding more linked sprites to some enemies myself and see if that works as well.

weluvgoatz

The strawbox also is missing its lightsprite when enflamed, as it produces a black missing texture image.

MatusGuy

While reviewing this there was one main thing in my mind: Is the loading cached? When a sprite is loaded, and then the same sprite is loaded, does it parse again? I'm unsure about the efficiency on this.

Also, in my review comments I mention a lot of stuff that looks like it only happens once, but it doesn't. A good example is several classes having their own light sprite.

Fantastic work though. I saw some great effort put into this.

src/object/bonus_block.cpp

src/object/explosion.cpp

src/object/moving_sprite.cpp

src/object/powerup.cpp

src/object/bullet.cpp

src/sprite/sprite_data.cpp

src/supertux/menu/async_dialog.hpp

Vankata453 · 2024-11-23T12:26:16Z

When a sprite is loaded, and then the same sprite is loaded, does it parse again?

No, it's created through SpriteManager::create(), which caches SpriteData.

Crushers and bricks now use linked sprites, instead of cloning their own sprite and setting actions on its clone.

[ci skip]

weluvgoatz · 2024-11-23T20:38:05Z

The key linked sprite is fixed! But the strawbox one isn't. Also, now the gold bomb just doesn't have a glow at all.

weluvgoatz · 2024-12-01T06:23:16Z

I will test once the conflicts are resolved : )

…ites

Vankata453 · 2024-12-05T14:57:27Z

The key linked sprite is fixed! But the strawbox one isn't. Also, now the gold bomb just doesn't have a glow at all.

Cannot reproduce these issues. Check if you have something in your user folder that perhaps is conflicting?

…"burn-light"

Rusty-Box

Looking good now!

weluvgoatz

Works perfectly now!

MatusGuy

Still not sure about the efficiency on this. I think we should build some sort of system to store light textures as surfaces instead of sprite files. Most of these "light sprite files" have only one light with one action anyway. But we can leave this suggestion for another PR, because this one is already heavily demanded, even by me.

Almost there!

MatusGuy · 2024-12-06T13:01:05Z

external/sexp-cpp

Wow really? What did you change here?

MatusGuy · 2024-12-06T13:09:38Z

src/object/bonus_block.cpp

@@ -139,7 +138,7 @@ BonusBlock::BonusBlock(const ReaderMapping& mapping) :
  if (m_contents == Content::LIGHT || m_contents == Content::LIGHT_ON)
  {
    SoundManager::current()->preload("sounds/switch.ogg");
-    m_lightsprite = Surface::from_file("/images/objects/lightmap_light/bonusblock_light.png");
+    m_lightsprite = m_sprite->create_linked_sprite("on-light");


This m_lightsprite name still hasn't been changed. In my opinion, if you are required to load & allocate another sprite, just to control when to draw it, then this system is heavily flawed. At least I think that's what's going on... The PowerUp class seems to handle this fine.

What this is doing is only creating the "on-light" sprite when it's needed, which is only if the bonus block contains light.

src/object/flower.cpp

Vankata453 added 6 commits January 28, 2024 21:29

Linked sprite support

355eb19

Objects which utilize more than 1 sprite now get the files of their additional sprites from the main one's "linked-sprites" list. This allows for expanded sprite customization for objects.

MovingSprite light sprite support

653d258

Custom lightsprites can now be added to all objects, which inherit `MovingSprite`. Setting a custom color for the lightsprite is also possible, as long as the object is not designed to use foreign color values (for example, from an option).

MovingSprite: Use a map for linked sprites list, instead of struct

866af12

"light" -> "on-light"

bf855b5

[ci skip]

Undo unneeded changes to "red-potion.sprite"

073c426

[ci skip]

SpriteManager: Dummy sprite data handling improvements

f11eebf

mrkubax10 added type:feature category:code status:needs-review Work needs to be reviewed by other people labels Jan 30, 2024

Vankata453 requested review from Rusty-Box and mrkubax10 January 30, 2024 22:10

mrkubax10 approved these changes Feb 2, 2024

View reviewed changes

Vankata453 added 3 commits June 15, 2024 14:28

Default actions for linked sprites

25696a4

Merge remote-tracking branch 'supertux/master' into custom-linked-spr…

abb7455

…ites

Fix torch.sprite [ci skip]

c9ebd6e

MatusGuy and others added 4 commits August 20, 2024 20:09

dart light ooooo BUT ITS BLURRY WHAHAHA

90e8086

Un-hardcode linked sprite actions, allow for setting custom loop count

10269ad

Undo DiveMine hitbox changes [ci skip]

1743ffd

Undo DiveMine hitbox changes [ci skip]

f9bd9f7

Vankata453 added 5 commits November 18, 2024 19:09

Merge remote-tracking branch 'supertux/master' into custom-linked-spr…

0084152

…ites

Fix Candle custom light sprites not being configured

4f778d9

Do not use Dart light sprite as BadGuy::lightsprite

3a6141e

Fix SpriteData code duplication, remove sprite hardcoding for many …

87e89cf

…`SpriteParticle`s

Merge branch 'master' into custom-linked-sprites

4fddd07

Crusher now draws its custom light sprite

882eeb1

weluvgoatz requested changes Nov 23, 2024

View reviewed changes

Fix "Missing sprite" issues with some objects

a2f4d77

MatusGuy requested changes Nov 23, 2024

View reviewed changes

Vankata453 added 2 commits November 23, 2024 15:01

Replace m_sprite->clone() with a linked sprite in objects

380ea8b

Crushers and bricks now use linked sprites, instead of cloning their own sprite and setting actions on its clone.

"light" -> "on-light", remove unneeded set_blend

ebe57ca

Vankata453 requested review from MatusGuy and weluvgoatz November 23, 2024 13:12

Vankata453 added 2 commits November 23, 2024 15:15

Remove more unneeded set_blend(Blend::ADD)

22de58b

[ci skip]

WeakBlock: lightsprite -> m_burn_sprite

b5c798c

[ci skip]

Merge remote-tracking branch 'supertux/master' into custom-linked-spr…

40d37c9

…ites

Fix missing goldbomb "ticking-glow", attempt to fix dark WeakBlock …

080a666

…"burn-light"

Rusty-Box approved these changes Dec 6, 2024

View reviewed changes

weluvgoatz approved these changes Dec 6, 2024

View reviewed changes

MatusGuy requested changes Dec 6, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Linked sprite support, custom `MovingSprite` light sprites #2753

Linked sprite support, custom `MovingSprite` light sprites #2753

Vankata453 commented Jan 30, 2024 •

edited

Loading

Rusty-Box commented Jan 30, 2024

Vankata453 commented Jan 30, 2024

Rusty-Box commented Jan 30, 2024

Vankata453 commented Jan 30, 2024

MatusGuy commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024 •

edited

Loading

Rusty-Box commented Jun 18, 2024

Rusty-Box commented Jun 18, 2024

Rusty-Box commented Sep 8, 2024

Rusty-Box commented Nov 22, 2024

weluvgoatz left a comment

MatusGuy left a comment

Vankata453 commented Nov 23, 2024

weluvgoatz commented Nov 23, 2024

weluvgoatz commented Dec 1, 2024

Vankata453 commented Dec 5, 2024

Rusty-Box left a comment

weluvgoatz left a comment

MatusGuy left a comment

MatusGuy Dec 6, 2024

MatusGuy Dec 6, 2024 •

edited

Loading

Vankata453 Dec 6, 2024

Linked sprite support, custom MovingSprite light sprites #2753

Are you sure you want to change the base?

Linked sprite support, custom MovingSprite light sprites #2753

Conversation

Vankata453 commented Jan 30, 2024 • edited Loading

Rusty-Box commented Jan 30, 2024

Vankata453 commented Jan 30, 2024

Rusty-Box commented Jan 30, 2024

Vankata453 commented Jan 30, 2024

MatusGuy commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024

Rusty-Box commented Mar 13, 2024

Vankata453 commented Mar 13, 2024 • edited Loading

Rusty-Box commented Jun 18, 2024

Rusty-Box commented Jun 18, 2024

Rusty-Box commented Sep 8, 2024

Rusty-Box commented Nov 22, 2024

weluvgoatz left a comment

Choose a reason for hiding this comment

MatusGuy left a comment

Choose a reason for hiding this comment

Vankata453 commented Nov 23, 2024

weluvgoatz commented Nov 23, 2024

weluvgoatz commented Dec 1, 2024

Vankata453 commented Dec 5, 2024

Rusty-Box left a comment

Choose a reason for hiding this comment

weluvgoatz left a comment

Choose a reason for hiding this comment

MatusGuy left a comment

Choose a reason for hiding this comment

MatusGuy Dec 6, 2024

Choose a reason for hiding this comment

MatusGuy Dec 6, 2024 • edited Loading

Choose a reason for hiding this comment

Vankata453 Dec 6, 2024

Choose a reason for hiding this comment

Linked sprite support, custom `MovingSprite` light sprites #2753

Linked sprite support, custom `MovingSprite` light sprites #2753

Vankata453 commented Jan 30, 2024 •

edited

Loading

Vankata453 commented Mar 13, 2024 •

edited

Loading

MatusGuy Dec 6, 2024 •

edited

Loading