Document Sound Effects #742
Merged
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.
Reopening per request, this is actually PR #735
Renaming player
sound_effectstotriggersand documenting them. This is a bitflag object for each player and they mostly indicate that a certain effect should be triggered. For example, if a player is hit by a green shell, the trigger for starting a low tumble is activated. However, if the player cannot actually be hit by the shell (e.g. they are in a star state), then the tumble will not happen. In that sense, the object mostly represents triggers and not the actual effects (which are mostly set in theplayer->effectsattribute. The separation between the two attributes isn't perfect at categorizing triggers vs. effects though.May be wise to wait until the effects PR is done, since it's now clear the two are fairly closely related.