Feat(ships): Add "auto explosion" tag to create explosions fitting to the ship #10071

RisingLeaf · 2024-05-18T17:03:28Z

Feature

This PR addresses the bug/feature described in ~~my dreams~~ a stream by saug

Summary

This takes the default explosion formula from the wiki:

"blast radius" (Typical value: (shields + hull) * .01)
"shield damage" (Typical value: (shields + hull) * .10)
"hull damage" (Typical value: (shields + hull) * .05)
"hit force" (Typical value: (shields + hull) * .15)

and implements it in game with the name "auto explosion"
it can be useful for not having the worry about changing explosion values every time you change the ships hull/shields as it updates them automatically, note that this only works in data files and not in saves, as the automatically created weapon will be normally saved

full syntax:

ship
	"auto explosion" <base multiplier, default: 1>
			"blast radius" <multiplier, default: 0.01>
			"shield damage" <multiplier, default: 0.10>
			"hull damage" <multiplier, default: 0.05>
			"hit force" <multiplier, default: 0.15>

final calculation:

blast radius = (shields + hull) * baseMult * radiusMult
shield damage = (shields + hull) * baseMult * shieldMult
hull damage = (shields + hull) * baseMult * hullMult
hit force = (shields + hull) * baseMult * forceMult

Usage examples

Instead of:

ship "Arrow"
	sprite "ship/arrow"
	thumbnail "thumbnail/arrow"
	attributes
		category "Transport"
		"cost" 1200000
		"shields" 2000
		"hull" 400
		[...]
		weapon
			"blast radius" 24
			"shield damage" 240
			"hull damage" 120
			"hit force" 360

now do:

ship "Arrow"
	sprite "ship/arrow"
	thumbnail "thumbnail/arrow"
	attributes
		category "Transport"
		"cost" 1200000
		"shields" 2000
		"hull" 400
		[...]
	"auto explosion"

Testing Done

not yet

RisingLeaf · 2024-05-18T17:07:19Z

Note: could be expanded to add a multiplier to support higher ~~tiers~~ quality ships

Amazinite · 2024-05-18T17:08:14Z

Bear in mind that MZ eventually ditched this formula for T2+ ships because the explosions ended up getting way too big.

I think it'd make sense to allow this token to have a decimal value next to it that can be used to scale the default explosion. So "auto explosion" 0.5 would take the specified formulas and multiply their outputs by 0.5 to determine the value that actually gets used. (No value being equal to 1.)

this tag should be placed after the shields and hull values as it relies on them for calculation

Data keys shouldn't require a specific ordering to function. If one value needs information from another to work, that should be done in FinishLoading() functions.

Amazinite · 2024-05-18T17:09:47Z

It might also make sense to calculate the explosion damage on the fly when a ship explodes, should we want to concern ourselves with outfits that can increase/decrease the shields/hull of a ship.

RisingLeaf · 2024-05-18T17:13:27Z

It might also make sense to calculate the explosion damage on the fly when a ship explodes, should we want to concern ourselves with outfits that can increase/decrease the shields/hull of a ship.

We did not until now, so I would leave that to another PR, if that's ok.

Quantumshark · 2024-05-18T17:20:49Z

I think it'd make sense to allow this token to have a decimal value next to it that can be used to scale the default explosion. So "auto explosion" 0.5 would take the specified formulas and multiply their outputs by 0.5 to determine the value that actually gets used. (No value being equal to 1.)

Blast radius is lower relative to damage for higher-tier ships, so it wouldn't be a simple case of applying the same scaling factor to all four values.

RisingLeaf · 2024-05-18T17:22:41Z

I think it'd make sense to allow this token to have a decimal value next to it that can be used to scale the default explosion. So "auto explosion" 0.5 would take the specified formulas and multiply their outputs by 0.5 to determine the value that actually gets used. (No value being equal to 1.)

did that

Data keys shouldn't require a specific ordering to function. If one value needs information from another to work, that should be done in FinishLoading() functions.

and that

still need to test it

RisingLeaf · 2024-05-18T17:25:13Z

I think it'd make sense to allow this token to have a decimal value next to it that can be used to scale the default explosion. So "auto explosion" 0.5 would take the specified formulas and multiply their outputs by 0.5 to determine the value that actually gets used. (No value being equal to 1.)

Blast radius is lower relative to damage for higher-tier ships, so it wouldn't be a simple case of applying the same scaling factor to all four values.

could we square the multiplier for blast radius or something like that?
because adding more values to the attribute would remove the desired simplicity

…s-sky into auto-explosion

RisingLeaf · 2024-05-18T17:29:09Z

It might also make sense to calculate the explosion damage on the fly when a ship explodes, should we want to concern ourselves with outfits that can increase/decrease the shields/hull of a ship.

If we would want to do so, the LoadExplosion in Weapon would also be helpful so it lays at least some groundwork.

Amazinite · 2024-05-18T18:54:45Z

adding more values to the attribute would remove the desired simplicity

I think the simplicity comes in the fact that this node would be doing calculations for you rather than you needing to calculate what these values would be given a ship's hull and shields. That is, should we tweak the hull and shields of a ship, we don't then also need to tweak the explosion. So even if the node looked something like this, it would still be simpler to use:

"auto explosion" <global multiplier>
	"blast radius" <multiplier>
	"shield damage" <multiplier>
	"hull damage" <multiplier>
	"hit force" <multiplier>

RisingLeaf · 2024-05-18T18:56:00Z

adding more values to the attribute would remove the desired simplicity

I think the simplicity comes in the fact that this node would be doing calculations for you rather than you needing to calculate what these values would be given a ship's hull and shields. That is, should we tweak the hull and shields of a ship, we don't then also need to tweak the explosion. So even if the node looked something like this, it would still be simpler to use:
"auto explosion" <global multiplier>
	"blast radius" <multiplier>
	"shield damage" <multiplier>
	"hull damage" <multiplier>
	"hit force" <multiplier>

this almost looks like something that should be moved into a struct?

RisingLeaf · 2024-05-18T18:58:55Z

also could this be moved out of the attributes section?
reason being that it has nothing to do with an outfit

Amazinite · 2024-05-18T19:10:53Z

Given how this is set up, I think it does make more sense as a direct child of ship instead of attributes. weapon is only a child of attributes because attributes is actually an outfit node in disguise, which is able to have a weapon node. This new mechanic doesn't necessarily need to be in the same location as that weapon node, though.

RisingLeaf · 2024-05-18T19:14:33Z

Given how this is set up, I think it does make more sense as a direct child of ship instead of attributes. weapon is only a child of attributes because attributes is actually an outfit node in disguise, which is able to have a weapon node. This new mechanic doesn't necessarily need to be in the same location as that weapon node, though.

implemented, will update description, still needs testing XD

source/Ship.cpp

Co-authored-by: TomGoodIdea <108272452+TomGoodIdea@users.noreply.github.com>

warp-core · 2024-05-27T17:47:55Z

source/Weapon.h

@@ -59,6 +59,8 @@ class Weapon {
 public:
 	// Load from a "weapon" node, either in an outfit, a ship (explosion), or a hazard.
 	void LoadWeapon(const DataNode &node);
+	// Load attributes that represent a ship explosion.
+	void LoadExplosion(double blastRadius, double shieldDamage, double hullDamage, double hitForce);


LoadExplosion feels like an inappropriate name given that the method doesn't load the data from anything. It is given some values and it assigns some of its members those values.
I like SetExplosion more.

source/Ship.cpp

warp-core · 2024-05-27T18:00:28Z

source/Ship.cpp

@@ -601,6 +619,20 @@ void Ship::Load(const DataNode &node)
 // loaded yet. So, wait until everything has been loaded, then call this.
 void Ship::FinishLoading(bool isNewInstance)
 {
+	// Automatically create an explosion for this ship if requested but
+	// only if the ship does not already have a defined explosion.
+	if(autoExplosion.baseMult > 0. && !baseAttributes.IsWeapon())


Put autoExplosion in an std::optional.

source/Ship.cpp

Co-authored-by: warp-core <warp-core@users.noreply.github.com>

RisingLeaf

Trying to code via phone

source/Ship.cpp

source/Ship.h

source/Weapon.cpp

source/Weapon.h

source/Ship.cpp

source/PlayerInfo.h

RisingLeaf · 2024-05-27T20:21:20Z

@warp-core i think I adressed your comments

source/Ship.cpp

source/Weapon.h

Koranir · 2024-05-29T02:53:30Z

source/Ship.cpp

+	// Automatically create an explosion for this ship if requested but
+	// only if the ship does not already have a defined explosion.


Are we sure that we to have logic for explosion hierarchy? I'm not sure if there's a use-case for overriding the automatic explosion, so just directly setting the explosion in Load would be nicer and make it so that not every ship needs to carry around a vestigial autoExplosion variable that's never used again.

@Amazinite requested so.

Co-authored-by: Daniel <101683475+Koranir@users.noreply.github.com>

RisingLeaf · 2024-06-01T19:23:39Z

tested, seems to work

RisingLeaf added 2 commits May 18, 2024 18:57

auto explosion

af9c076

Update Outfit.cpp

7f86c20

update with decimal

f4ecf62

Update Ship.cpp

25a32fe

RisingLeaf added 3 commits May 18, 2024 19:26

Merge branch 'master' into auto-explosion

807d75d

Update Ship.cpp

b1e1758

Merge branch 'auto-explosion' of https://github.com/RisingLeaf/endles…

441860d

…s-sky into auto-explosion

TomGoodIdea added the enhancement A suggestion for new content or functionality that requires code changes label May 18, 2024

Merge branch 'master' into auto-explosion

c951b9c

RisingLeaf added 2 commits May 18, 2024 21:11

implemented

d416243

Update Ship.cpp

3aefb6c

whoops

000aa89

TomGoodIdea reviewed May 27, 2024

View reviewed changes

source/Ship.cpp Outdated Show resolved Hide resolved

Update Ship.cpp

65070f2

Co-authored-by: TomGoodIdea <108272452+TomGoodIdea@users.noreply.github.com>

warp-core reviewed May 27, 2024

View reviewed changes

RisingLeaf and others added 2 commits May 27, 2024 21:20

Update Ship.cpp

be68ebd

Co-authored-by: warp-core <warp-core@users.noreply.github.com>

Update Ship.cpp

b802dae

Co-authored-by: warp-core <warp-core@users.noreply.github.com>

RisingLeaf commented May 27, 2024

View reviewed changes

RisingLeaf added 2 commits May 27, 2024 21:34

Apply suggestions from code review

6a533d6

Update PlayerInfo.h

3523718

RisingLeaf commented May 27, 2024

View reviewed changes

source/Ship.cpp Outdated Show resolved Hide resolved

Update Ship.cpp

c7aa9b5

RisingLeaf commented May 27, 2024

View reviewed changes

source/PlayerInfo.h Outdated Show resolved Hide resolved

RisingLeaf added 2 commits May 27, 2024 22:09

Update Ship.h

f5a2e95

Update PlayerInfo.h

441301d

Merge branch 'master' into auto-explosion

fd1afae

Koranir suggested changes May 29, 2024

View reviewed changes

source/Ship.cpp Outdated Show resolved Hide resolved

source/Weapon.h Outdated Show resolved Hide resolved

Koranir reviewed May 29, 2024

View reviewed changes

RisingLeaf and others added 3 commits May 29, 2024 18:31

Update Ship.cpp

5b9718c

Co-authored-by: Daniel <101683475+Koranir@users.noreply.github.com>

Update Weapon.h

0480221

Co-authored-by: Daniel <101683475+Koranir@users.noreply.github.com>

Merge branch 'master' into auto-explosion

fce2aa4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat(ships): Add "auto explosion" tag to create explosions fitting to the ship #10071

Feat(ships): Add "auto explosion" tag to create explosions fitting to the ship #10071

RisingLeaf commented May 18, 2024 •

edited

RisingLeaf commented May 18, 2024 •

edited

Amazinite commented May 18, 2024 •

edited

Amazinite commented May 18, 2024

RisingLeaf commented May 18, 2024

Quantumshark commented May 18, 2024

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024

Amazinite commented May 18, 2024 •

edited

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024 •

edited

Amazinite commented May 18, 2024 •

edited

RisingLeaf commented May 18, 2024

warp-core May 27, 2024

warp-core May 27, 2024

RisingLeaf left a comment

RisingLeaf commented May 27, 2024

Koranir May 29, 2024

RisingLeaf May 29, 2024

RisingLeaf commented Jun 1, 2024

		// Automatically create an explosion for this ship if requested but
		// only if the ship does not already have a defined explosion.

Feat(ships): Add "auto explosion" tag to create explosions fitting to the ship #10071

Are you sure you want to change the base?

Feat(ships): Add "auto explosion" tag to create explosions fitting to the ship #10071

Conversation

RisingLeaf commented May 18, 2024 • edited

Summary

Usage examples

Testing Done

RisingLeaf commented May 18, 2024 • edited

Amazinite commented May 18, 2024 • edited

Amazinite commented May 18, 2024

RisingLeaf commented May 18, 2024

Quantumshark commented May 18, 2024

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024

Amazinite commented May 18, 2024 • edited

RisingLeaf commented May 18, 2024

RisingLeaf commented May 18, 2024 • edited

Amazinite commented May 18, 2024 • edited

RisingLeaf commented May 18, 2024

warp-core May 27, 2024

Choose a reason for hiding this comment

warp-core May 27, 2024

Choose a reason for hiding this comment

RisingLeaf left a comment

Choose a reason for hiding this comment

RisingLeaf commented May 27, 2024

Koranir May 29, 2024

Choose a reason for hiding this comment

RisingLeaf May 29, 2024

Choose a reason for hiding this comment

RisingLeaf commented Jun 1, 2024

RisingLeaf commented May 18, 2024 •

edited

RisingLeaf commented May 18, 2024 •

edited

Amazinite commented May 18, 2024 •

edited

Amazinite commented May 18, 2024 •

edited

RisingLeaf commented May 18, 2024 •

edited

Amazinite commented May 18, 2024 •

edited