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.

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

Update documentation to match state of released game #5

Merged
merged 43 commits into from
Nov 12, 2022
Merged

Conversation

1337joe
Copy link
Owner

@1337joe 1337joe commented Nov 12, 2022

Work remaining (future pull request):

  • EngineUnit: new breakout of various types of thrust producing modules isn't yet captured

Elements documented from codex but not tested in-game due to lack of access to an element:

  • AntiGravityGeneratorUnit
  • PlasmaExtractorUnit
  • WarpDriveUnit

Breaking changes for using mocks (probably not a complete list):

  • Element definition keys have changed to match the default element name in-game (in English). This is typically the displayNameWithSize in the table returned by system.getItem(id).
  • IndustryUnit currentStatus field refactored to currentState to better match game behavior.
  • Methods deprecated from system/ControlUnit/CoreUnit to Player/Construct don't forward through to Player/Construct, so tests relying on the deprecated method will fail until redirected to the new location.

This addresses the bulk of the work for #4

@github-actions
Copy link

github-actions bot commented Nov 12, 2022

Test Results

  37 files    37 suites   1s ⏱️
256 tests 254 ✔️ 2 💤 0
254 runs  252 ✔️ 2 💤 0

Results for commit eebb4e2.

♻️ This comment has been updated with latest results.

@codecov-commenter
Copy link

codecov-commenter commented Nov 12, 2022

Codecov Report

Base: 88.72% // Head: 85.49% // Decreases project coverage by -3.23% ⚠️

Coverage data is based on head (21c8bed) compared to base (0bd0500).
Patch coverage: 77.57% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main       #5      +/-   ##
==========================================
- Coverage   88.72%   85.49%   -3.24%     
==========================================
  Files          37       40       +3     
  Lines        4356     5481    +1125     
==========================================
+ Hits         3865     4686     +821     
- Misses        491      795     +304     
Impacted Files Coverage Δ
src/dumocks/BaseShieldGeneratorUnit.lua 0.00% <0.00%> (ø)
src/dumocks/PlasmaExtractorUnit.lua 0.00% <0.00%> (ø)
src/dumocks/CoreUnit.lua 67.83% <44.19%> (-10.61%) ⬇️
src/dumocks/MiningUnit.lua 81.33% <61.53%> (-11.78%) ⬇️
src/dumocks/RadarUnit.lua 67.56% <64.15%> (-1.10%) ⬇️
src/dumocks/ShieldGeneratorUnit.lua 86.69% <64.28%> (-4.38%) ⬇️
src/dumocks/EngineUnit.lua 82.35% <66.66%> (+2.02%) ⬆️
src/dumocks/ControlUnit.lua 84.35% <69.23%> (-10.74%) ⬇️
src/dumocks/ManualButtonUnit.lua 90.27% <69.23%> (-4.81%) ⬇️
src/dumocks/PressureTileUnit.lua 90.14% <69.23%> (-4.86%) ⬇️
... and 66 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@1337joe 1337joe merged commit f1b9a2f into main Nov 12, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants