[WIP] Sequence Instructions Documentation #1248
Draft
+227
−227
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
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.
This PR adds documentation to all the sequence instructions introduced in the audio extraction PR #1236. This WIP will hopefully give context to the sequence instructions to all the OoT sequences, and help reviewers with understanding the scripts and extraction process for sequences introduce in audio extraction.
The current approach is to just use comments on the switch cases to pair instructions to cases, I am unsure if it is worth making macro's for this long list of instructions for a single use case. I added a brief description of each instruction names as many of the instructions are very abbreviated (too abbreviated imo but that's a discussion for the other PR).
This will likely remain a WIP until the audio extraction PR is complete, and is here more for reference to help review audio extraction, and to discuss how we want to sync the documentation of sequence instructions between sequences themselves and in
audio_seqplayer.c