[CHORE] Correct event cancelable status comments in ScriptEventType#7602
Open
ahmed7p wants to merge 1 commit into
Open
[CHORE] Correct event cancelable status comments in ScriptEventType#7602ahmed7p wants to merge 1 commit into
ahmed7p wants to merge 1 commit into
Conversation
github-actions
Bot
added
status: pending triage
NotHyper-474
added
status: pending triage
Hundrec
changed the title
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
2 participants
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.
Description
This PR updates the documentation comments inside
ScriptEventType.hxto accurately reflect the actual engine behavior regarding script events.Key Changes
GAME_OVER,SONG_END,NOTE_HOLD_DROP,SONG_BEAT_HIT,SONG_STEP_HIT, and_BEGINstate events to explicitly state they IS cancelable, aligning them with their implementation and logic checks in the source code.SONG_BEAT_HITdescription from "once per step" to "once per beat".This ensures modders and custom script creators have an accurate API reference when working with the engine's event system.