Commenting the main flows #156
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
twof
commented
Dec 12, 2024
Comment on lines
-95
to
-103
| let team = { | ||
| let data = data_mut(sim, handle); | ||
| data.ttl -= dt as f32; | ||
| if data.ttl <= 0.0 { | ||
| destroy(sim, handle); | ||
| continue; | ||
| } | ||
| data.team | ||
| }; |
There was a problem hiding this comment.
I was having a little trouble parsing this when I was looking at it. It was unclear to me why mutations were being done inside the constructor for the team variable, so I restructured the code to make it a little easier to read.
twof
commented
Dec 12, 2024
Comment on lines
-937
to
-941
| let ship_data = self | ||
| .simulation | ||
| .ship_data | ||
| .get_mut(self.handle.index()) | ||
| .unwrap(); |
There was a problem hiding this comment.
this line was the same as data_mut, so I replaced it with data_mut
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I want to do a little work on the project, but I wanted to understand how it functioned first. I studied the main flows (compilation, running the simulation), and left some descriptive comments along the way.
There are a couple of very small code changes that I'll mark, but I can revert them if you'd like.
Would it be helpful to have a writeup about the game's architecture in the wiki? I'd be down to throw one together while it's on my mind.