Note

Kind	class
Package	objects
Full name	objects.Note
Source	source/objects/Note.hx
Extends	FlxSprite

The note object used as a data structure to spawn and manage notes during gameplay.

If you want to make a custom note type, you should search for: "function set_noteType"

Public fields

Name	Type	Static	Default	Notes
extraData	Map<String, Dynamic>	no	new Map<String, Dynamic>()	—
parentST	Float	no	0	—
parentSL	Float	no	0	—
strumTime	Float	no	0	—
mustPress	Bool	no	false	—
doOppStuff	Bool	no	false	—
noteData	Int	no	0	—
canBeHit	Bool	no	false	—
tooLate	Bool	no	false	—
wasGoodHit	Bool	no	false	—
ignoreNote	Bool	no	false	—
hitByOpponent	Bool	no	false	—
pendingKill	Bool	no	false	Whether this note is already queued in PlayState.killNotes, waiting for the end-of-frame kill(). Replaces an Array.contains() scan per note per frame, and is reset by setupNoteData() so a recycled note never starts queued. (#88)
blockHit	Bool	no	false	—
noteDensity	Float	no	1	—
sustainLength	Float	no	0	—
isSustainNote	Bool	no	false	—
isSustainEnd	Bool	no	false	—
noteType	String	no	null	property (default, set)
eventName	String	no	''	—
eventLength	Int	no	0	—
eventVal1	String	no	''	—
eventVal2	String	no	''	—
rgbShader	RGBShaderReference	no	—	—
globalRgbShaders	Array<RGBPalette>	yes	[]	—
inEditor	Bool	no	Type.getClassName(Type.getClass(FlxG.state)) == 'editors.ChartingState'	—
animSuffix	String	no	''	—
gfNote	Bool	no	false	—
earlyHitMult	Float	no	0.5	—
lateHitMult	Float	no	1	—
lowPriority	Bool	no	false	—
SUSTAIN_SIZE	Int	yes	44	final
swagWidth	Float	yes	160 * 0.7	final
colArray	Array<String>	yes	['purple', 'blue', 'green', 'red']	final
defaultNoteSkin	String	yes	'noteskins/NOTE_assets'	property (default, never)
noteSplashData	NoteSplashData	no	{	—
noteHoldSplash	SustainSplash	no	—	—
noteSplashDisabled	Bool	no	false	Lua shit
offsetX	Float	no	0	—
offsetY	Float	no	0	—
offsetAngle	Float	no	0	—
multAlpha	Float	no	1	—
multSpeed	Float	no	1	—
copyX	Bool	no	true	—
copyY	Bool	no	true	—
copyAngle	Bool	no	true	—
copyAlpha	Bool	no	true	—
copyScaleX	Bool	no	true	—
copyScaleY	Bool	no	true	—
hitHealth	Float	no	0.023	—
missHealth	Float	no	0.0475	—
rating	String	no	'unknown'	—
ratingMod	Float	no	0	—
ratingDisabled	Bool	no	false	—
texture	String	no	null	property (default, set)
sustainScale	Float	no	1.0	—
noAnimation	Bool	no	false	—
noMissAnimation	Bool	no	false	—
hitCausesMiss	Bool	no	false	—
distance	Float	no	2000	—
hitsoundDisabled	Bool	no	false	—
pixelNote	Bool	no	false	—
useRGBShader	Bool	no	true	property (default, set)
originalHeight	Float	no	6	—

Public methods

defaultRGB

function defaultRGB()

View source

toJson

function toJson()

View source

toString

override function toString()

View source

new (constructor)

function new(?newStrumTime:Float, ?newNoteData:Int)

Parameter	Type	Default
newStrumTime (optional)	Float	—
newNoteData (optional)	Int	—

View source

followStrum

inline function followStrum(strum:StrumNote, songSpeed:Float = 1):Void

Parameter	Type	Default
strum	StrumNote	—
songSpeed (optional)	Float	1

View source

clipToStrumNote

function clipToStrumNote(myStrum:StrumNote)

Parameter	Type	Default
myStrum	StrumNote	—

View source

destroy

override function destroy()

View source

updateRGBColors

function updateRGBColors()

View source

setupNoteData

function setupNoteData(chartNoteData:PreloadedChartNote):Void

Parameter	Type	Default
chartNoteData	PreloadedChartNote	—

View source

Internals

Private / internal members

Field	Type	Static
changeSize	Bool	no
noteColor	Array<FlxColor>	no
_lastNoteOffX	Float	no
_lastValidChecked	String	yes
superCoolColor	—	no
arr	Array<Int>	no
rainbowTime	—	no
firstOffX	—	no
shouldCenterOffsets	Bool	no

Method
function set_useRGBShader(value:Bool):Bool
function set_texture(value:String):String
function set_noteType(value:String):String
function reloadNote(texture:String = '', postfix:String = '')
override function update(elapsed:Float)
override function set_clipRect(rect:FlxRect):FlxRect