From bc546e86aa77ffc795b3f079de5f590289a9c583 Mon Sep 17 00:00:00 2001
From: EliteMasterEric <ericmyllyoja@gmail.com>
Date: Sat, 5 Oct 2024 13:33:08 -0400
Subject: [PATCH] Clean up documentation in StrumlineNote

---
 source/funkin/play/notes/StrumlineNote.hx | 29 +++++++++++++++++------
 1 file changed, 22 insertions(+), 7 deletions(-)

diff --git a/source/funkin/play/notes/StrumlineNote.hx b/source/funkin/play/notes/StrumlineNote.hx
index fedd71ae8..ebe95e920 100644
--- a/source/funkin/play/notes/StrumlineNote.hx
+++ b/source/funkin/play/notes/StrumlineNote.hx
@@ -2,22 +2,24 @@ package funkin.play.notes;
 
 import funkin.play.notes.notestyle.NoteStyle;
 import flixel.graphics.frames.FlxAtlasFrames;
-import flixel.FlxSprite;
+import funkin.graphics.FunkinSprite;
 import funkin.play.notes.NoteSprite;
 
 /**
  * The actual receptor that you see on screen.
  */
-class StrumlineNote extends FlxSprite
+class StrumlineNote extends FunkinSprite
 {
+  /**
+   * Whether this strumline note is on the player's side or the opponent's side.
+   */
   public var isPlayer(default, null):Bool;
 
+  /**
+   * The direction which this strumline note is facing.
+   */
   public var direction(default, set):NoteDirection;
 
-  var confirmHoldTimer:Float = -1;
-
-  static final CONFIRM_HOLD_TIME:Float = 0.1;
-
   function set_direction(value:NoteDirection):NoteDirection
   {
     this.direction = value;
@@ -30,6 +32,16 @@ class StrumlineNote extends FlxSprite
    */
   public var forceActive:Bool = false;
 
+  /**
+   * How long to continue the hold note animation after a note is pressed.
+   */
+  static final CONFIRM_HOLD_TIME:Float = 0.1;
+
+  /**
+   * How long the hold note animation has been playing after a note is pressed.
+   */
+  var confirmHoldTimer:Float = -1;
+
   public function new(noteStyle:NoteStyle, isPlayer:Bool, direction:NoteDirection)
   {
     super(0, 0);
@@ -47,7 +59,10 @@ class StrumlineNote extends FlxSprite
     this.active = true;
   }
 
-  function onAnimationFrame(name:String, frameNumber:Int, frameIndex:Int):Void {}
+  function onAnimationFrame(name:String, frameNumber:Int, frameIndex:Int):Void
+  {
+    // Do nothing.
+  }
 
   function onAnimationFinished(name:String):Void
   {