Draft - Lib Component #810

royfalk · 2023-11-10T20:14:31Z

Lib component decouples the code base into discrete components - drive, life support, reactor, etc.

Code Changes:

Have the PR Validation Tests been run? See https://github.com/vegastrike/Vega-Strike-Engine-Source/wiki/Pull-Request-Validation
This is a documentation change only

Issues:

TBD

closes vegastrike#751 Also add tests and a few additional methods to store.

…gine-Source

Add missing return. Other minor fixes.

Introduce the concept of components.

Move a lot of code into individual components.

BenjamenMeyer · 2023-11-11T02:57:07Z

engine/src/cmd/basecomputer.cpp

        if (shields_require_power) {
            maxshield = 0;
        }
        PRETTY_ADDU(statcolor + "Minimum time to reach full overthrust speed: #-c",
                playerUnit->getMass() * uc.max_ab_speed() / playerUnit->limits.afterburn, 2, "seconds");
        //reactor
-        float avail = (playerUnit->maxEnergyData() * RSconverter - maxshield * VSDM);
+        float avail = (playerUnit->energy_manager.GetReactorCapacity() * RSconverter - maxshield * VSDM);


we probably should fix this

BenjamenMeyer

one little change and we should be good.

engine/src/cmd/ai/aggressive.cpp

BenjamenMeyer · 2023-11-11T02:52:34Z

engine/src/cmd/ai/firekeyboard.cpp

        Arrested(parent);
-    }
+    }*/


I wonder if this was put in for a story line. If so, we should find a different way to implement it.

Even if they did, if we run out of reactor before we get to a base, life support goes out and we die (to be implemented). This straight out doesn't make sense on any level.

Maybe this is one of those "fence" situations. I would like to ask some of the long-term project members whether they remember what this code was for.

BenjamenMeyer · 2023-11-11T02:57:07Z

engine/src/cmd/basecomputer.cpp

        if (shields_require_power) {
            maxshield = 0;
        }
        PRETTY_ADDU(statcolor + "Minimum time to reach full overthrust speed: #-c",
                playerUnit->getMass() * uc.max_ab_speed() / playerUnit->limits.afterburn, 2, "seconds");
        //reactor
-        float avail = (playerUnit->maxEnergyData() * RSconverter - maxshield * VSDM);
+        float avail = (playerUnit->energy_manager.GetReactorCapacity() * RSconverter - maxshield * VSDM);


we probably should fix this

BenjamenMeyer · 2023-11-11T03:09:15Z

engine/src/components/component.cpp

+        return std::rand();
+    }
+
+    return 1.0;


this should probably be:

double random_value = std::rand(); if (random_value < 0.2) { return random_value; } return 1.0;

As it is, if L40 passes then a new random number will be used and it could still be greater than or equal to 0.2, thereby likely defeating the check.

@BenjamenMeyer You are correct, AFAICT.

stephengtuggy

A couple minor things to change, and I haven't finished looking through all of this code in detail yet. But overall, I really like the direction this is headed.

stephengtuggy · 2023-11-24T21:33:34Z

engine/src/components/component.h

+    bool damaged = false;
+public:
+    Component();
+    virtual ~Component() {}


Nice. I see you have the virtual destructor here, for a class that's intended to be inherited. Excellent.

It's semantics, but can no longer upgrade. Rather, can be damaged. Add unit tests. Fix bug in constructor. Fix bug in operator +=. Also, rename SPEC to more generic FTL. It's a better term even if it's not accurate.

This is an interim commit. Implement shield component fully: - Add code in base computer to allow sale of component. Also modify shield info in that file. - Some changes to shields in units.json to support this. Add Type and Facets. Issues: - Shields don't work right as power isn't fully implemented. - Color of shield component is listed as damaged. Additionally: Switch Health from float to Resource<double> Add pointers to Resource to support DamageableUnit pointers (e.g. hull). Fix bug in resource, where an update won't change current value. Fix subtle bug in basecomputer, where all armor stats reflect 2nd facet only.

Add armor tests Refactor Components::Load to remove dependency on Unit Fix bug in Resource class Fix bug in Hull and implement some missing code Refactor UnitCsvFactory to remove dependencies

Fix issue in DL::GetPercent. Not sure why it wasn't caught by the compiler before. Note: hull upgrade was disabled

Fix issues with shields in SPEC and SetAdjustedMaxValue

Remove energy manager Make Cloak a Component subclass Implement Reactor, Shield and Armor more fully Remove Damageable::regenerateShields - now part of shield and more consistent

Implement energy_container and consumer. Remove redundant files - energy_types, energy_manager and fuel.

BenjamenMeyer · 2024-04-20T22:37:40Z

engine/src/components/armor.cpp

+void Armor::SaveToCSV(std::map<std::string, std::string>& unit) const {
+    for(int i=0;i<8;i++) {
+        unit[armor_facets[i]] = std::to_string(facets[i].health.Value());
+    }


is this only CSV? or any format? Could we just name this Save?

All our saves are CSV only. A proper JSON save would be hierarchical.

Ship

Component (e.g. radar)

Damage to specific attribute.

The current system saves everything as one big struct. When you repair or downgrade, it checks the stock attributes. It works but because everything is in one file, you can't do any unit tests.

BenjamenMeyer · 2024-04-20T22:39:27Z

engine/src/components/component.h

+    // Load from units dictionary
+    virtual void Load(std::string upgrade_key, std::string unit_key);      
+
+    virtual void SaveToCSV(std::map<std::string, std::string>& unit) const = 0;


is this doing something specific to CSV files? Or does it work for JSON and other formats too?
E.g could we just call it Save? Or does it need to only apply to CSV files?

All our saves are CSV only.

It'd be nice to change that up. I'd like to change the saved game format to use JSON too, perhaps also use a zip like format similar to ODF. But that's another refactor

Since CSV is an implementation detail that could change, it's probably better to describe it more generically. I think Save or Saves is great, personally.

royfalk · 2024-04-24T16:14:06Z

This PR got out of hand. I'll wait until @BenjamenMeyer and I finish discussing something and then I'll close it.
I'll port the code here in manageable parts.

stephengtuggy · 2024-04-24T23:02:19Z

This PR got out of hand. I'll wait until @BenjamenMeyer and I finish discussing something and then I'll close it.
I'll port the code here in manageable parts.

Thanks. I was not looking forward to reviewing this. LOL

royfalk added 13 commits January 23, 2023 20:01

Fix bug - Store::Subtract adds quantity instead of subtracting it

2701083

closes vegastrike#751 Also add tests and a few additional methods to store.

Merge from master

7e0e45f

Merge branch 'master' of https://github.com/vegastrike/Vega-Strike-En…

0cb1a73

…gine-Source

Merge branch 'master' of https://github.com/vegastrike/Vega-Strike-En…

c6dba50

…gine-Source

Merge branch 'master' of https://github.com/vegastrike/Vega-Strike-En…

b2d8681

…gine-Source

Refactor cloaking in the game

8668683

Move cloak code from unit_csv to cloak class

e38f3fa

Add missing return. Other minor fixes.

Add missing return statement

0dd2465

Merge branch 'task_aug_unit' into task_almost_september

e74dd23

Implement radar code as a separate component

c663324

Introduce the concept of components.

Fix bug in the radar where small ships are not tracked.

7c357ba

Merge branch 'task_almost_september' into task_october

474e401

Introduce lib_component

9d5551e

Move a lot of code into individual components.

royfalk requested review from BenjamenMeyer and stephengtuggy November 10, 2023 20:14

royfalk self-assigned this Nov 10, 2023

github-advanced-security bot found potential problems Nov 10, 2023

View reviewed changes

BenjamenMeyer added this to the 0.9.x milestone Nov 11, 2023

BenjamenMeyer added the enhancement label Nov 11, 2023

BenjamenMeyer requested changes Nov 11, 2023

View reviewed changes

royfalk mentioned this pull request Nov 24, 2023

Refactor master part list #816

Closed

2 tasks

stephengtuggy reviewed Nov 24, 2023

View reviewed changes

royfalk mentioned this pull request Nov 29, 2023

Task mpl 2 #819

Merged

royfalk added 6 commits March 12, 2024 09:13

Refactor resource class

2c0e12b

It's semantics, but can no longer upgrade. Rather, can be damaged. Add unit tests. Fix bug in constructor. Fix bug in operator +=. Also, rename SPEC to more generic FTL. It's a better term even if it's not accurate.

Move regeneration from health to shield

f509220

Further work on Armor class

a4a8a7d

Add armor tests Refactor Components::Load to remove dependency on Unit Fix bug in Resource class Fix bug in Hull and implement some missing code Refactor UnitCsvFactory to remove dependencies

Make Shield a super class of DamageableLayer

ab8538a

Fix issue in DL::GetPercent. Not sure why it wasn't caught by the compiler before. Note: hull upgrade was disabled

Make armor class a superclass of DamageableLayer

799a732

Fix issues with shields in SPEC and SetAdjustedMaxValue

royfalk added 3 commits March 29, 2024 18:06

Make Hull a superclass of DamageableLayer

77d3dab

Add fuel component

019b507

Remove energy manager Make Cloak a Component subclass Implement Reactor, Shield and Armor more fully Remove Damageable::regenerateShields - now part of shield and more consistent

Implement afterburners and Drive

7f53ea9

Implement energy_container and consumer. Remove redundant files - energy_types, energy_manager and fuel.

BenjamenMeyer reviewed Apr 20, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Draft - Lib Component #810

Draft - Lib Component #810

royfalk commented Nov 10, 2023

BenjamenMeyer Nov 11, 2023

stephengtuggy Nov 24, 2023

BenjamenMeyer left a comment

BenjamenMeyer Nov 11, 2023

royfalk Nov 22, 2023

stephengtuggy Nov 24, 2023

BenjamenMeyer Nov 11, 2023

BenjamenMeyer Nov 11, 2023

stephengtuggy Nov 24, 2023

stephengtuggy left a comment

stephengtuggy Nov 24, 2023

BenjamenMeyer Apr 20, 2024

royfalk Apr 24, 2024

BenjamenMeyer Apr 20, 2024

royfalk Apr 24, 2024

BenjamenMeyer Apr 24, 2024

stephengtuggy Apr 24, 2024

royfalk commented Apr 24, 2024

stephengtuggy commented Apr 24, 2024

Draft - Lib Component #810

Are you sure you want to change the base?

Draft - Lib Component #810

Conversation

royfalk commented Nov 10, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

BenjamenMeyer 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

stephengtuggy 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

royfalk commented Apr 24, 2024

stephengtuggy commented Apr 24, 2024