Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

refactor: Rewrite Entity Component System #1110

Draft
wants to merge 122 commits into
base: main
Choose a base branch
from
Draft

refactor: Rewrite Entity Component System #1110

wants to merge 122 commits into from

Conversation

aronwk-aaron
Copy link
Member

@aronwk-aaron aronwk-aaron commented Jun 9, 2023 •
edited
Loading

The purpose of this PR it to overhaul the Entity Component System (ECS) with knowledge gained from reverse engineering the client.
Goals are to:

  • Reduced code duplication between components
  • Optimize hot code paths to be more efficient
  • Less error prone way to Add a component to an Entity
  • Use unique_ptr for Component storage so that it is clear that when an Entity is deleted, its components are too.
  • Remove an ungodly amount of crusty code
  • Clearer and less error prone creation and initialization of components through a constructor, and then all initialization and loading is done through and Startup and loader methods
  • Remove outdated C like component getting
  • Use proper delta compression for serialization
  • Add tests for serialization to ensure progression and future protection
  • etc (I couldn't think of anything else, this is just a fun thing to do after doing a LOT of RE)

aronwk-aaron and others added 30 commits February 10, 2023 21:33
@aronwk-aaron
Break out the model component
c168f6c 
into the model, item, and mutable model behaviors
@aronwk-aaron
Merge branch 'main' into item-component
5097862
@aronwk-aaron
fix cmake
2ae9a92
@aronwk-aaron
include
c2d5be0
@aronwk-aaron
Merge branch 'main' into item-component
5e9a956
@aronwk-aaron
hey it compiles
15988af
@EmosewaMC
Rename some variables in Component
716a5fc 
And add more virtuals
@EmosewaMC
I hope this works
ea9d0d8
@EmosewaMC
Move to shared pointer
9e9e4dc
@aronwk-aaron
update component names, document heirarchy
d11e2db
@EmosewaMC
holy mother of const
ec00f5f 
Use const everywhere that makes sense
return const variables when it makes sense
const functions and variables again, where it makes sense
No raw access and modifications to protected members
Move template definitions to tcc file

idk how I feel about this one
@EmosewaMC
Remove shared pointer, ODR of componentType variable
62aa863
@EmosewaMC
Replace all auto with auto*
e2dfa18 
For components
@EmosewaMC
Rename from GetOwningEntity to GetParentEntity
f555ba8
@EmosewaMC
Rename some variables
6f05720 
- Add order for loading Components
- Enforce all components have Entity* in the first argument
@EmosewaMC
Add blank classes for some Components
5da776a 
Racing Stats

Minigame Control
@EmosewaMC
Update CMakeLists.txt
f2d28cc
@EmosewaMC
Update includes for propertyEnteranceComponent
0b37dc1 
Class must be complete to be used in a MoveAssignment
@EmosewaMC
Further re-implement Entity::Initialize
e3a716a 
wheee
@EmosewaMC
Merge branch 'main' into components-wheeeee
ddc5f0e
@aronwk-aaron
Rename RebuildComponent to QuickbuildComponent
a68fa69
@EmosewaMC
Add test for component Whitelists
1c23f3c
@EmosewaMC
More robust tests
2a27997
@EmosewaMC
Use std algorithms
5714ac5
@EmosewaMC
Update to actually work with component list
cebe3c7
@EmosewaMC
Collectible, Item, further re-implement initialize
b91f84d
@EmosewaMC
Destroyable
0b5df9f
@EmosewaMC
Continued re-integration of Entity::Initialize
77dc6ff
@EmosewaMC
Quickbuild and Destroyable reintegration
5f139c7
@EmosewaMC
doesnt have a component
b43e5c2
EmosewaMC and others added 27 commits July 4, 2023 22:52
@EmosewaMC
LUPExhibitComponent cleanup
68a2a04
@aronwk-aaron
Merge branch 'main' into components-wheeeee
197d1bc
@EmosewaMC
MissionComponent pass
950a1fe
@EmosewaMC
MissionOfferComponent pass
001f6a7
@EmosewaMC
ModelBehaviorComponent pass
5301346
@EmosewaMC
SwitchComponent pass
cf53e35
@EmosewaMC
ModuleAssemblyComponent pass
28fbe20
@EmosewaMC
Merge branch 'components-wheeeee' of https://github.com/DarkflameUniv…
790bd6c 
…erse/DarkflameServer into components-wheeeee
@EmosewaMC
Merge branch 'components-wheeeee' of https://github.com/DarkflameUniv…
1b7be5d 
…erse/DarkflameServer into components-wheeeee
@EmosewaMC
add final
2528e02
@EmosewaMC
MovementAiComponent pass
8a512e5
@EmosewaMC
I am throwing this one out later.
d2a7e14
@EmosewaMC
MultiZoneEntranceComponent pass
7ca9e59
@EmosewaMC
MutableModelBehaviorComponent pass
83780af
@EmosewaMC
PetComponent pass
87675aa
@EmosewaMC
PhantomPhysicsComponent pass
28637a2
@EmosewaMC
PlayerForcedMovementComponent pass
598d88b
@EmosewaMC
PossessableComponent pass
fe6b279
@EmosewaMC
PhantomPhysicsComponent pass
59831fc
@EmosewaMC
PossessionComponent pass
4d88f63
@EmosewaMC
PropertyComponent pass
37bcc81
@EmosewaMC
push no pass
8678ed0
@EmosewaMC
idek if ill keep this but yeah
a37ec32
@EmosewaMC
PropertyVendorComponent pass
c204ea4
@EmosewaMC
ProximityMonitorComponent re-pass
49f3d75
@EmosewaMC
RailActivatorComponent pass
949a6db
@EmosewaMC
local work
6240eef
aronwk-aaron
aronwk-aaron commented Jul 12, 2023
View reviewed changes
dGame/dComponents/RailActivatorComponent.cpp
m_DamageImmune = m_ParentEntity->GetVar<bool>(u"rail_activator_damage_immune");
m_NoAggro = m_ParentEntity->GetVar<bool>(u"rail_no_aggro");
m_NotifyArrived = m_ParentEntity->GetVar<bool>(u"rail_notify_activator_arrived");
m_ShowNameBillboard = m_ParentEntity->GetVar<bool>(u"rail_show_name_billboard");
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've wondered, does this need to talk to the Player Forced movement component. that has two bools that are serialized ("is on rail" and "show billboard"), which this has vars for

@aronwk-aaron
Copy link
Member Author

This PR wont be merged, but remains a draft since there's a lot of research in this PR that will be implemented in smaller chunks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@EmosewaMC EmosewaMC EmosewaMC left review comments

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@aronwk-aaron @EmosewaMC