Codename LogoCodename Logo

funkin.game.Strum

APIWikiTools
View source

class Strum

package funkin.game

extends FlxSprite

Constructor

View on GitHub

new(?X:Float, ?Y:Float, ?SimpleGraphic:Null<FlxGraphicAsset>)

Variables

animSuffix:String = ""

Which animation suffix on characters that should be used when hitting notes.

copyStrumAngle:Bool = true

copyStrumCamera:Bool = true

copyStrumScrollX:Bool = true

copyStrumScrollY:Bool = true

extra:Map<String, Dynamic> = []

Extra data that can be added to the strum.

extraCopyFields:Array<String> = []

read onlylastDrawCameras:Array<FlxCamera> = []

lastHit:Float = -5000

The last time the note/confirm animation was hit.

noteAngle:Null<Float> = null

The direction of the notes. If you don't want angle of the strum to interfere with the direction the notes are going, you can set noteAngle to = 0, and then you can use the angle of the strum without it affecting the direction of the notes.

scrollSpeed:Null<Float> = null

The scroll speed of the notes.

strumLine:StrumLine = null

The strum line that this strum belongs to.

updateNotesPosX:Bool = true

updateNotesPosY:Bool = true

getJustPressed:StrumLine ‑> Bool = null

Whenever the strum was just pressed.

getJustReleased:StrumLine ‑> Bool = null

Whenever the strum was just released.

getPressed:StrumLine ‑> Bool = null

Whenever the strum is pressed.

Methods

View on GitHub

inlinegetAnim():String

Gets the current animation name.

View on GitHub

inlinegetNotesAngle(?note:Note):Float

Gets the angle of the notes. If you don't want angle of the strum to interfere with the direction the notes are going, you can set noteAngle to = 0, and then you can use the angle of the strum without it affecting the direction of the notes.

Parameters:

note

(Optional) The note

View on GitHub

inlinegetScrollSpeed(?note:Note):Float

Gets the scroll speed of the notes.

Parameters:

note

(Optional) The note

View on GitHub

playAnim(anim:String, force:Bool = true):Void

Plays an animation.

Parameters:

anim

The animation name

force

Whenever the animation should be forced to play

View on GitHub

inlinepress(time:Float):Void

Plays the confirm animation.

Parameters:

time

The time

View on GitHub

updateNotePosition(daNote:Note):Void

Updates the position of a note.

Parameters:

daNote

The note

View on GitHub

updatePlayerInput(pressed:Bool, justPressed:Bool, justReleased:Bool):Void

Updates the animation state based on the player input.

Parameters:

pressed

Whenever the player is pressing the button

justPressed

Whenever the player just pressed the button

justReleased

Whenever the player just released the button

View on GitHub

inlineupdateSustain(daNote:Note):Void

Updates a sustain note.

Parameters:

daNote

The note