docs: add struct field documentation and fix semantic issues#78
Merged
Conversation
- Add comprehensive comments to all model struct fields documenting: - What each field represents - SQF command and argument order reference - OCAP ID vs Object ID clarification - Fix IsAwake -> IsUnconscious semantic inversion in Ace3UnconsciousEvent to match SQF behavior (true = unconscious, not awake) - Add missing :PROJECTILE: fields: - SimulationType (index 17) - ammo simulation type - IsSubmunition (index 18) - whether from cluster/split ammo - MagazineIcon (index 19) - magazine icon texture path
Merging this branch will decrease overall coverage
Coverage by fileChanged files (no unit tests)
Please note that the "Total", "Covered", and "Missed" counts above refer to code statements instead of lines of code. The value in brackets refers to the test coverage of that file in the old version of the code. Changed unit test files
|
This file contains hidden or 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
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.
Summary
IsAwake→IsUnconscioussemantic inversion inAce3UnconsciousEventto match SQF behavior:PROJECTILE:fields:SimulationType,IsSubmunition,MagazineIconChanges
Model Documentation
Added detailed comments to all struct fields in
model.goincluding:ObjectIDrefers to OCAP-assigned sequential IDs (not Arma netId)Bug Fix: Semantic Inversion
The SQF sends
_isUnconscious(true when unconscious) but the Go struct hadIsAwake(inverted semantics). Fixed across:internal/model/model.gointernal/model/core/events.gointernal/model/convert/convert.gointernal/handlers/handlers.goMissing Fields Added
Added three missing fields to
ProjectileEventper the SQF specification:SimulationType(index 17) - e.g., shotBullet, shotShell, shotRocketIsSubmunition(index 18) - whether projectile is from cluster/split ammoMagazineIcon(index 19) - path to magazine icon textureTest plan
go build ./...passesgo test ./internal/handlers/... ./internal/model/... ./internal/storage/...passes