Ratings event addition to the engine (#1015)

* Update PlayState.hx Implemented RatingsShowEvent * Add files via upload * Update pixel.hx Update because of ratings commits * Update PlayState.hx put the flxpoints after they're used, forgot to use event.tweenDuration in displayRatingNumbers * Update PlayState.hx oops * Update PlayState.hx I'm so not careful * Update PlayState.hx Commited NoteHitEvent checks for all display rating functions * Update PlayState.hx oops 2 * Update NoteHitEvent.hx made the rating vars null class * Update PlayState.hx juust in case * Update PlayState.hx oops 3 * Update RatingsShowEvent.hx Implemented a rating var which allows you to change the rating sprite. * Update PlayState.hx Implemented a rating var (In RatingsShowEvent) which allows you to change the rating sprite. * Update PlayState.hx now it should support displayRating/Combo being set from note hit event * Update PlayState.hx fixed a possibility where if the display bool was set to false or the event was cancelled, then it would still display the sprite as a haxeflixel logo
2026-06-28 09:31:59 +07:00
parent cb4ecc521f
commit a485080c27
4 changed files with 206 additions and 66 deletions
@@ -0,0 +1,91 @@
+package funkin.backend.scripting.events.gameplay;
+
+import flixel.math.FlxPoint;
+
+final class RatingsShowEvent extends CancellableEvent 
+{
+	/**
+	 * Rating sprite (may be null)
+	*/
+	public var ratingSprite:Null<FlxSprite>;
+	/**
+	 * Number sprite (may be null)
+	*/
+	public var numberSprite:Null<FlxSprite>;
+	/**
+	 * Combo sprite (may be null)
+	*/
+	public var comboSprite:Null<FlxSprite>;
+	/**
+	 * Scale of combo numbers. (may be null)
+	 */
+	public var numScale:Null<Float> = 0.5;
+	/**
+	 * Whenever antialiasing should be enabled on combo numbers. (may be null)
+	 */
+	public var numAntialiasing:Null<Bool> = true;
+	/**
+	 * Scale of the rating sprites. (may be null)
+	 */
+	public var ratingScale:Null<Float> = 0.7;
+	/**
+	 * Whenever antialiasing should be enabled on ratings. (may be null)
+	 */
+	public var ratingAntialiasing:Null<Bool> = true;
+	/**
+	 * Prefix of the rating sprite path. Defaults to "game/score/"
+	 */
+	public var ratingPrefix:String;
+	/**
+	 * Suffix of the rating sprite path.
+	 */
+	public var ratingSuffix:String;
+	/**
+	 * The sprite's acceleration.
+	 */
+	public var acceleration:Float;
+	/**
+	 * A FlxPoint which x or y properties preposition the sprites current velocity.
+	 */
+	public var velocity:FlxPoint;
+	/**
+	 * The duration of the sprite's alpha tween.
+	 */
+	public var tweenDuration:Float;
+	/**
+	 * The start delay of the sprite's alpha tween.
+	 */
+	public var startDelay:Float;
+	/**
+	 * Whenever the Rating sprites should be shown or not.
+	 */
+	public var displayRating:Bool;
+	/**
+	 * Whenever the Rating sprites should be shown or not.
+	 */
+	public var displayNumbers:Bool;
+	/**
+	 * Whenever the Combo sprite should be shown or not (like old Week 7 patches).
+	 */
+	public var displayCombo:Bool;
+	/**
+	 * Whether the sprite should be tweened or not.
+	 */
+	public var tween:Bool;
+	/**
+	 * The amount of spacing for the combo numbers. (may be null)
+	 */
+	public var numSpacing:Null<Float>;
+	/**
+	 * The position of the sprite.
+	 */
+	public var position:FlxPoint;
+	/**
+  	 * Whether to reset the sprite or not.
+     */
+	public var resetSprite:Bool;
+	/**
+     * The rating name of the rating sprite. (may be null)
+	 */
+	public var rating:Null<String>;
+}
@@ -34,11 +34,11 @@ final class NoteHitEvent extends CancellableEvent {
 	/**
 	 * Whenever the Rating sprites should be shown or not.
 	 */
-	public var displayRating:Bool;
+	public var displayRating:Null<Bool>;
 	/**
 	 * Whenever the Combo sprite should be shown or not (like old Week 7 patches).
 	 */
-	public var displayCombo:Bool;
+	public var displayCombo:Null<Bool>;
 	/**
 	 * Note that has been pressed
 	 */
@@ -66,11 +66,11 @@ final class NoteHitEvent extends CancellableEvent {
 	/**
 	 * Prefix of the rating sprite path. Defaults to "game/score/"
 	 */
-	public var ratingPrefix:String;
+	public var ratingPrefix:Null<String>;
 	/**
 	 * Suffix of the rating sprite path.
 	 */
-	public var ratingSuffix:String;
+	public var ratingSuffix:Null<String>;
 	/**
 	 * Direction of the press (0 = Left, 1 = Down, 2 = Up, 3 = Right)
 	 */
@@ -98,19 +98,19 @@ final class NoteHitEvent extends CancellableEvent {
 	/**
 	 * Scale of combo numbers.
 	 */
-	public var numScale:Float = 0.5;
+	public var numScale:Null<Float>;
 	/**
 	 * Whenever antialiasing should be enabled on combo number.
 	 */
-	public var numAntialiasing:Bool = true;
+	public var numAntialiasing:Null<Bool>;
 	/**
 	 * Scale of ratings.
 	 */
-	public var ratingScale:Float = 0.7;
+	public var ratingScale:Null<Float>;
 	/**
 	 * Whenever antialiasing should be enabled on ratings.
 	 */
-	public var ratingAntialiasing:Bool = true;
+	public var ratingAntialiasing:Null<Bool>;
 	/**
 	 * Whenever the animation should be forced to play (if it's null it will be forced based on the sprite's data xml, if it has one).
 	 */