States

PlayState

PlayState Called Functions

jk i got nothing for this

PlayState Variables

Variable	Type	Description
instance	PlayState	Current PlayState instance.
SONG	SwagSong	Song Metadata
isStoryMode	bool	Whenever the song is being played in Story Mode.
storyWeek	WeekData	The week data of the current week.
storyPlaylist	array	The remaining songs in the Story Mode playlist.
difficulty	string	The selected difficulty name, default value is "normal".
fromMods	bool	Whenever the week is coming from the mods folder or not.
scripts	ScriptPack	Script Pack of all the scripts being ran.
gameOverSong	string	Game Over Song at assets/music/gameOver.ogg, default value is "gameOver"
lossSFX	string	Game Over Song at assets/sounds/gameOverSFX.ogg, default value is "gameOverSFX"
retrySFX	string	Game Over End SFX, used when retrying. assets/sounds/gameOverEnd.ogg, default value is "gameOverEnd"
stage	Stage	Current Stage.
canDie	bool	Whenever the player can die, default value is true.
scrollSpeed	float	Current scroll speed for all strums. To set a scroll speed for a specific strum, use strum.scrollSpeed.
downscroll	bool	Whenever the game is in downscroll or not. (Can be set)
inst	FlxSound	Instrumental sound (Inst.ogg).
vocals	FlxSound	Vocals sound (Vocals.ogg).
dad	Character	Dad character
gf	Character	Girlfriend character
boyfriend	Character	Boyfriend character
notes	NoteGroup	Group of all of the notes. Using forEach on this group will only loop through the first notes.
strumLine	FlxObject	Strum line position.
ratingNum	int	Number of ratings.
camFollow	FlxObject	Object defining the camera follow target.
ratingNum	int	Number of ratings.
prevCamFollow	FlxObject	Previous cam follow.
strumLineNotes	FlxTypedGroup	All of the strum line notes.
playerStrums	FlxTypedGroup	Player strums.
cpuStrums	FlxTypedGroup	CPU strums.
splashHandler	SplashHandler	Note splashes container.
splashHandler	SplashHandler	Note splashes container.
muteVocalsOnMiss	bool	Whenever the vocals should be muted when a note is missed, default value is true.
canAccessDebugMenus	bool	Whenever the player can press 7, 8 or 9 to access the debug menus, default value is true.
camZooming	bool	Whenever cam zooming is enabled, enables on a note hit if not cancelled.
camZoomingInterval	int	Interval of cam zooming (beats). For example: if set to 4, the camera will zoom every 4 beats.
camZoomingStrength	float	How strong the cam zooms should be, default value is 1.
maxCamZoom	float	Maximum amount of zoom for the camera, default value is 1.35.
curSong	string	Current song name (lowercase)
gfSpeed	int	Interval at which Girlfriend dances, default value is 1.
health	float	Current health. Goes from 0 to maxHealth.
maxhealth	float	Maximum health the player can have. Defaults to 2.
combo	int	Current combo.
comboBreaks	bool	Whenever the misses should show "Combo Breaks" instead of "Misses", default value is false.
healthBarBG	FlxSprite	Health bar background.
healthBar	FlxBar	Health bar.
generatedMusic	bool	Whenever the music has been generated.
startingSong	bool	Whenever the song is currently being started.
iconP1	HealthIcon	Player's icon.
iconP2	HealthIcon	Opponent's icon.
camHUD	HudCamera	Camera for the HUD (notes, misses).
camGame	FlxCamera	Camera for the game (stages, characters).
songScore	int	The player's current score.
misses	int	The player's amount of misses.
accuracy	float	The player's accuracy (shortcut to accuracyPressedNotes / totalAccuracyAmount).
accuracyPressedNotes	float	The number of pressed notes.
totalAccuracyAmount	float	The total accuracy amount.
scoreTxt	FunkinText	FunkinText that shows your score.
missesTxt	FunkinText	FunkinText that shows your amount of misses.
accuracyTxt	FunkinText	FunkinText that shows your accuracy.
campaignScore	int	Score for the current week.
defaultCamZoom	float	Camera zoom at which the game lerps to.
daPixelZoom	float	Zoom for the pixel assets.
inCutscene	bool	Whenever the game is currently in a cutscene or not.
playCutscenes	bool	Whenever the game should play the cutscenes. Defaults to whenever the game is currently in Story Mode or not.
cutscene	string	Cutscene script path.
endCutscene	string	End cutscene script path.
curRating	ComboRating	Last rating (may be null)
startTimer	FlxTimer	Timer for the start countdown.
introLength	int	Length of the intro countdown.
introSprites	array	Array of sprites for the intro.
introSounds	array	Array of sounds for the intro.
paused	bool	Whenever the game is paused or not.
startedCountdown	bool	Whenever the countdown has started or not.
canPause	bool	Whenever the game can be paused or not.
curSection	SwagSection	Current section (can be null when using YoshiCrafter Engine charts).
accFormat	FlxTextFormat	Format for the accuracy rating.
endingSong	bool	Whenever the song is ending or not.
comboGroup	FlxSpriteGroup	Group containing all of the combo sprites.
noteTypesArray	array	Array containing all of the note types names.
hitWindow	float	Hit window, in milliseconds. Defaults to 250ms unless changed in options(?). Base game hit window is 175ms.
comboRatings	array	All combo ratings.
detailsText	string	unsure
detailsPausedText	string	unsure