Public fields
| Name | Type | Static | Default | Notes |
|---|
instance | PlayState | yes | — | — |
STRUM_X | — | yes | 48 | — |
STRUM_X_MIDDLESCROLL | — | yes | -278 | — |
renderPath | String | no | ClientPrefs.renderPath | property (default, null) |
middleScroll | Bool | yes | false | — |
ratingStuff | Array<Dynamic> | yes | [] | — |
boyfriendMap | Map<String, Boyfriend> | no | new Map() | — |
dadMap | Map<String, Character> | no | new Map() | — |
gfMap | Map<String, Character> | no | new Map() | — |
modchartTweens | Map<String, FlxTween> | no | new Map<String, FlxTween>() | — |
modchartSprites | Map<String, ModchartSprite> | no | new Map<String, ModchartSprite>() | `#if LUA_ALLOWED \ |
modchartSprites | Map<String, Dynamic> | no | new Map<String, Dynamic>() | `#if !(LUA_ALLOWED \ |
modchartTimers | Map<String, FlxTimer> | no | new Map<String, FlxTimer>() | — |
modchartSounds | Map<String, FlxSound> | no | new Map<String, FlxSound>() | — |
modchartTexts | Map<String, FlxText> | no | new Map<String, FlxText>() | — |
modchartSaves | Map<String, FlxSave> | no | new Map<String, FlxSave>() | — |
hitSoundString | String | no | ClientPrefs.hitsoundType | — |
BF_X | Float | no | 770 | — |
BF_Y | Float | no | 100 | — |
DAD_X | Float | no | 100 | — |
DAD_Y | Float | no | 100 | — |
GF_X | Float | no | 400 | — |
GF_Y | Float | no | 130 | — |
songSpeedTween | FlxTween | no | — | — |
songSpeed | Float | no | 1 | property (default, set) |
songSpeedType | String | no | "multiplicative" | — |
noteKillOffset | Float | no | 350 | — |
playbackRate | Float | no | 1 | property (default, set) |
npsSpeedMult | Float | no | 1 | — |
frameCaptured | Int | no | 0 | — |
boyfriendGroup | FlxSpriteGroup | no | — | — |
dadGroup | FlxSpriteGroup | no | — | — |
gfGroup | FlxSpriteGroup | no | — | — |
grpCrossFade | FlxTypedGroup<CrossFade> | no | — | — |
grpGFCrossFade | FlxTypedGroup<CrossFade> | no | — | — |
grpBFCrossFade | FlxTypedGroup<CrossFade> | no | — | — |
shaderUpdates | Array<Float->Void> = [] | no | — | — |
curStage | String | yes | '' | — |
stageUI | String | yes | "normal" | — |
isPixelStage | Bool | yes | false | — |
SONG | SwagSong | yes | null | — |
isStoryMode | Bool | yes | false | — |
wasOriginallyFreeplay | Bool | yes | false | — |
storyWeek | Int | yes | 0 | — |
storyPlaylist | Array<String> | yes | [] | — |
storyDifficulty | Int | yes | 1 | — |
healthDrainAmount | Float | no | 0.023 | — |
healthDrainFloor | Float | no | 0.1 | — |
splashesPerFrame | Array<Int> | no | [0, 0, 0, 0] | — |
inst | FlxSound | no | — | — |
vocals | FlxSound | no | — | — |
opponentVocals | FlxSound | no | — | — |
dad | Character | no | null | — |
gf | Character | no | null | — |
boyfriend | Boyfriend | no | null | — |
bfNoteskin | String | no | null | — |
dadNoteskin | String | no | null | — |
iconOffset | Int | yes | 26 | — |
notes | FlxTypedGroup<Note> | no | — | — |
sustainNotes | FlxTypedGroup<Note> | no | — | — |
killNotes | Array<Note> | no | [] | — |
unspawnNotes | Array<PreloadedChartNote> | no | [] | — |
eventNotes | Array<EventNote> | no | [] | — |
camFollow | FlxPoint | no | — | Handles the new epic mega sexy cam code that i've done |
camFollowPos | FlxObject | no | — | — |
strumLineNotes | FlxTypedGroup<StrumNote> | no | — | — |
opponentStrums | FlxTypedGroup<StrumNote> | no | — | — |
playerStrums | FlxTypedGroup<StrumNote> | no | — | — |
grpHoldSplashes | FlxTypedGroup<SustainSplash> | no | — | — |
grpNoteSplashes | FlxTypedGroup<NoteSplash> | no | — | — |
camZooming | Bool | no | false | — |
camZoomingMult | Float | no | 1 | — |
camZoomingDecay | Float | no | 2.5 | — |
gfSpeed | Int | no | 1 | — |
health | Float | no | — | — |
maxHealth | Float | no | 2 | — |
botEnergy | Float | no | 1 | — |
totalNotesPlayed | Float | no | 0 | — |
combo | Float | no | 0 | — |
maxCombo | Float | no | 0 | — |
missCombo | Int | no | 0 | — |
healthBar | FlxBar | no | — | — |
timeBar | FlxBar | no | — | — |
energyBar | FlxBar | no | — | — |
energyTxt | FlxText | no | — | — |
ratingsData | Array<Rating> | no | Rating.loadDefault() | — |
perfects | Int | no | 0 | — |
sicks | Int | no | 0 | — |
goods | Int | no | 0 | — |
bads | Int | no | 0 | — |
poorRatings | Int | no | 0 | — |
nps | Float | no | 0 | — |
maxNPS | Float | no | 0 | — |
oppNPS | Float | no | 0 | — |
maxOppNPS | Float | no | 0 | — |
enemyHits | Float | no | 0 | — |
opponentNoteTotal | Float | no | 0 | — |
polyphonyOppo | Float | no | 1 | — |
polyphonyBF | Float | no | 1 | — |
endingSong | Bool | no | false | — |
startingSong | Bool | no | false | — |
changedDifficulty | Bool | yes | false | — |
chartingMode | Bool | yes | false | — |
playerIsCheating | Bool | yes | false | — |
disableBotWatermark | Bool | yes | false | — |
shownScore | Float | no | 0 | — |
fcStrings | Array<String> | no | ['No Play', 'PFC', 'SFC', 'GFC', 'BFC', 'FC', 'SDCB', 'Clear', 'TDCB', 'QDCB'] | — |
hitStrings | Array<String> | no | ['Perfect!!!', 'Sick!!', 'Good!', 'Bad.', 'Shit.', 'Miss..'] | — |
healthGain | Float | no | 1 | Gameplay settings |
healthLoss | Float | no | 1 | — |
hpDrainLevel | Float | no | 1 | — |
instakillOnMiss | Bool | no | false | — |
sickOnly | Bool | no | false | — |
cpuControlled | Bool | no | false | property (default, set) |
practiceMode | Bool | no | false | — |
opponentDrain | Bool | no | false | — |
opponentChart | Bool | yes | false | — |
bothSides | Bool | yes | false | — |
trollingMode | Bool | no | false | — |
jackingtime | Float | no | 0 | — |
minSpeed | Float | no | 0.1 | — |
maxSpeed | Float | no | 10 | — |
botplaySine | Float | no | 0 | — |
botplayTxt | FlxText | no | — | — |
renderedTxt | FlxText | no | — | — |
iconP1 | HealthIcon | no | — | — |
iconP2 | HealthIcon | no | — | — |
camHUD | FlxCamera | no | — | — |
camGame | FlxCamera | no | — | — |
camOther | FlxCamera | no | — | — |
cameraSpeed | Float | no | 1 | — |
scoreTxtUpdateFrame | Int | no | 0 | ok moxie this doesn't cause memory leaks |
popUpsFrame | Int | no | 0 | — |
missRecalcsPerFrame | Int | no | 0 | — |
hitImagesFrame | Int | no | 0 | — |
screenshader | PulseEffectAlt | yes | — | — |
singDurMult | Int | no | 1 | — |
msTxt | MSText | no | — | ms timing popup shit |
msTimer | FlxTimer | no | null | — |
restartTimer | FlxTimer | no | null | — |
judgeTxt | JudgeText | no | — | ms timing popup shit except for simplified ratings |
judgeTxtTimer | FlxTimer | no | null | — |
oppScore | Float | no | 0 | — |
songScore | Float | no | 0 | — |
songHits | Int | no | 0 | — |
songMisses | Float | no | 0 | — |
scoreTxt | FlxText | no | — | — |
campaignScore | Float | yes | 0 | — |
campaignMisses | Int | yes | 0 | — |
seenCutscene | Bool | yes | false | — |
deathCounter | Int | yes | 0 | — |
shouldDrainHealth | Bool | yes | false | — |
defaultCamZoom | Float | no | — | property (get, set) |
ogCamZoom | Float | no | 1.05 | — |
daPixelZoom | Float | yes | 6 | how big to stretch the pixel art assets |
sectionsLoaded | Int | yes | 0 | — |
notesLoadedRN | Int | no | 0 | — |
inCutscene | Bool | no | false | — |
skipCountdown | Bool | no | false | — |
boyfriendCameraOffset | Array<Float> | no | null | — |
opponentCameraOffset | Array<Float> | no | null | — |
girlfriendCameraOffset | Array<Float> | no | null | — |
luaArray | Array<FunkinLua> | no | [] | #if LUA_ALLOWED · Lua shit |
pythonArray | Array<PythonScript> | no | [] | #if PYTHON_ALLOWED · Python shit |
hscriptArray | Array<HScript> | no | [] | #if HSCRIPT_ALLOWED · HScript shit (standalone .hx/.hscript mods, no Lua parent required) |
introSoundsSuffix | String | no | '' | — |
songName | String | no | — | — |
startCallback | Void->Void = null | no | — | Callbacks for stages |
endCallback | Void->Void = null | no | — | — |
runtimeShaders | Map<String, Array<String>> | no | new Map<String, Array<String>>() | #if SHADERS_ALLOWED |
videoCutscene | VideoSprite | no | null | *********** |
psychDialogue | DialogueBoxPsych | no | — | — |
countdownReady | FlxSprite | no | — | For being able to mess with the sprites on Lua |
countdownSet | FlxSprite | no | — | — |
countdownGo | FlxSprite | no | — | — |
startOnTime | Float | yes | 0 | — |
skipArrowStartTween | Bool | no | false | — |
canResync | Bool | no | true | — |
autoUpdateRPC | Bool | no | true | Updating Discord Rich Presence. |
paused | Bool | no | false | — |
canReset | Bool | no | true | — |
takenTime | Float | no | haxe.Timer.stamp() | — |
totalRenderTime | Float | no | 0 | — |
amountOfRenderedNotes | Float | no | 0 | — |
maxRenderedNotes | Float | no | 0 | — |
skippedCount | Float | no | 0 | — |
maxSkipped | Float | no | 0 | — |
isDead | Bool | no | false | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
gameOverTimer | FlxTimer | no | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
transitioning | — | no | false | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
totalPlayed | Int | no | 0 | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
totalNotesHit | Float | no | 0.0 | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
totalNotes | Float | no | 0 | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
showComboNum | Bool | no | true | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
showRating | Bool | no | true | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
popUpGroup | FlxTypedSpriteGroup<Popup> | no | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end · Stores Ratings and Combo Sprites in a group |
strumsBlocked | Array<Bool> | no | [] | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
ratingName | String | no | '?' | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
ratingString | String | no | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
ratingPercent | Float | no | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
ratingFC | String | no | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end |
process | Process | yes | — | #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if sys |
Public methods
onResize
override function onResize(width:Int, height:Int):Void
| Parameter | Type | Default |
|---|
width | Int | — |
height | Int | — |
View source
create
override function create()
View source
createRuntimeShader
function createRuntimeShader(shaderName:String):ErrorHandledRuntimeShader
Only compiled when #if SHADERS_ALLOWED.
| Parameter | Type | Default |
|---|
shaderName | String | — |
View source
initLuaShader
function initLuaShader(name:String)
Only compiled when #if SHADERS_ALLOWED.
| Parameter | Type | Default |
|---|
name | String | — |
View source
addTextToDebug
function addTextToDebug(text:String, color:FlxColor)
| Parameter | Type | Default |
|---|
text | String | — |
color | FlxColor | — |
View source
reloadHealthBarColors
function reloadHealthBarColors(leftColorArray:Array<Int>, rightColorArray:Array<Int>)
| Parameter | Type | Default |
|---|
leftColorArray | Array<Int> | — |
rightColorArray | Array<Int> | — |
View source
addCharacterToList
function addCharacterToList(newCharacter:String, type:Int)
| Parameter | Type | Default |
|---|
newCharacter | String | — |
type | Int | — |
View source
addShaderToCamera
function addShaderToCamera(cam:String, effect:Dynamic)
| Parameter | Type | Default |
|---|
cam | String | — |
effect | Dynamic | — |
View source
removeShaderFromCamera
function removeShaderFromCamera(cam:String, effect:Dynamic)
| Parameter | Type | Default |
|---|
cam | String | — |
effect | Dynamic | — |
View source
clearShaderFromCamera
function clearShaderFromCamera(cam:String)
| Parameter | Type | Default |
|---|
cam | String | — |
View source
getLuaObject
function getLuaObject(tag:String, text:Bool = true):FlxSprite
| Parameter | Type | Default |
|---|
tag | String | — |
text (optional) | Bool | true |
View source
startVideo
function startVideo(name:String, library:String = null, ?callback:Void->Void = null, forMidSong:Bool = false, canSkip:Bool = true, loop:Bool = false, playOnLoad:Bool = true)
| Parameter | Type | Default |
|---|
name | String | — |
library (optional) | String | null |
callback (optional) | Void->Void = null, forMidSong:Bool = false, canSkip:Bool = true, loop:Bool = false, playOnLoad:Bool = true | — |
View source
startAndEnd
View source
startDialogue
function startDialogue(dialogueFile:DialogueFile, song:String = null):Void
You don't have to add a song, just saying. You can just do "startDialogue(dialogueJson);" and it should work
| Parameter | Type | Default |
|---|
dialogueFile | DialogueFile | — |
song (optional) | String | null |
View source
changeTheSettingsBitch
function changeTheSettingsBitch()
View source
static function formatNumber(number:Float, decimals:Bool = false):String
| Parameter | Type | Default |
|---|
number | Float | — |
decimals (optional) | Bool | false |
View source
startCountdown
function startCountdown():Void
View source
addBehindGF
function addBehindGF(obj:FlxObject)
| Parameter | Type | Default |
|---|
obj | FlxObject | — |
View source
addBehindBF
function addBehindBF(obj:FlxObject)
| Parameter | Type | Default |
|---|
obj | FlxObject | — |
View source
addBehindDad
function addBehindDad(obj:FlxObject)
| Parameter | Type | Default |
|---|
obj | FlxObject | — |
View source
clearNotesBefore
function clearNotesBefore(time:Float)
| Parameter | Type | Default |
|---|
time | Float | — |
View source
updateScore
function updateScore(miss:Bool = false)
| Parameter | Type | Default |
|---|
miss (optional) | Bool | false |
View source
setSongTime
function setSongTime(time:Float)
| Parameter | Type | Default |
|---|
time | Float | — |
View source
startNextDialogue
function startNextDialogue()
View source
skipDialogue
View source
lerpSongSpeed
function lerpSongSpeed(num:Float, time:Float):Void
| Parameter | Type | Default |
|---|
num | Float | — |
time | Float | — |
View source
onFocus
override function onFocus():Void
View source
onFocusLost
override function onFocusLost():Void
View source
update
override function update(elapsed:Float)
| Parameter | Type | Default |
|---|
elapsed | Float | — |
View source
updateIconsScale
function updateIconsScale(elapsed:Float)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
elapsed | Float | — |
View source
updateIconsPosition
function updateIconsPosition()
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
loopCallback
function loopCallback(startingPoint:Float = 0)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
startingPoint (optional) | Float | 0 |
View source
getControl
function getControl(key:String)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
key | String | — |
View source
triggerEventNote
function triggerEventNote(eventName:String, value1:String, value2:String, strumTime:Float)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
eventName | String | — |
value1 | String | — |
value2 | String | — |
strumTime | Float | — |
View source
moveCameraSection
function moveCameraSection():Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
moveCamera
function moveCamera(focus:String = "bf")
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
focus (optional) | String | "bf" |
View source
unpauseVocals
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
pauseVocals
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
setVocalsTime
function setVocalsTime(time:Float)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
time | Float | — |
View source
finishSong
function finishSong(ignoreNoteOffset:Bool = false):Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
ignoreNoteOffset (optional) | Bool | false |
View source
loopSongLol
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
endSong
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
KillNotes
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
restartSong
function restartSong(noTrans:Bool = true)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
noTrans (optional) | Bool | true |
View source
getKeyFromEvent
function getKeyFromEvent(key:FlxKey):Int
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
key | FlxKey | — |
View source
parseKeys
function parseKeys(ret:Array<Bool>, suffix:String = ''):Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
ret | Array<Bool> | — |
suffix (optional) | String | '' |
View source
invalidateNote
function invalidateNote(note:Note):Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
note | Note | — |
View source
destroyNotes
function destroyNotes():Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
spawnHoldSplashOnNote
function spawnHoldSplashOnNote(note:Note, isDad:Bool = false)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
note | Note | — |
isDad (optional) | Bool | false |
View source
spawnHoldSplash
function spawnHoldSplash(note:Note)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
note | Note | — |
View source
spawnNoteSplashOnNote
function spawnNoteSplashOnNote(isDad:Bool, note:Note)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
isDad | Bool | — |
note | Note | — |
View source
spawnNoteSplash
function spawnNoteSplash(x:Float, y:Float, data:Int, note:Note = null)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
x | Float | — |
y | Float | — |
data | Int | — |
note (optional) | Note | null |
View source
characterBopper
function characterBopper(beat:Int):Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
beat | Int | — |
View source
playerDance
function playerDance():Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
doTwist
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
bopIcons
function bopIcons(bopBF:Bool = false)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
bopBF (optional) | Bool | false |
View source
startLuasOnFolder
function startLuasOnFolder(luaFile:String)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if LUA_ALLOWED.
| Parameter | Type | Default |
|---|
luaFile | String | — |
View source
startPythonScriptOnFolder
function startPythonScriptOnFolder(pyFile:String)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if PYTHON_ALLOWED.
| Parameter | Type | Default |
|---|
pyFile | String | — |
View source
startHScriptOnFolder
function startHScriptOnFolder(hxFile:String)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if HSCRIPT_ALLOWED.
Load a standalone HScript mod by mod-relative path. The extension is
optional: stages/farm tries farm.hx first, then farm.hscript,
in each case through the usual mod folders, then assets/preload.
| Parameter | Type | Default |
|---|
hxFile | String | — |
View source
removeHScript
function removeHScript(hxFile:String)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if HSCRIPT_ALLOWED.
Stop and unload a running standalone HScript mod (extension optional).
| Parameter | Type | Default |
|---|
hxFile | String | — |
View source
callOnScripts
function callOnScripts(event:String, args:Array<Dynamic> = null, ignoreStops = true, exclusions:Array<String> = null, excludeValues:Array<Dynamic> = null):Dynamic
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
Dispatch a callback to every Lua, Python AND standalone HScript script
(in that order). Returns the last non-Function_Continue value
returned by any script.
| Parameter | Type | Default |
|---|
event | String | — |
args (optional) | Array<Dynamic> | null |
ignoreStops (optional) | Dynamic | true |
exclusions (optional) | Array<String> | null |
excludeValues (optional) | Array<Dynamic> | null |
View source
hasActiveScripts
inline function hasActiveScripts():Bool
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
callOnLuas
function callOnLuas(event:String, args:Array<Dynamic> = null, ignoreStops = true, exclusions:Array<String> = null, excludeValues:Array<Dynamic> = null):Dynamic
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
Kept for compatibility: dispatches to Lua, Python and HScript scripts.
| Parameter | Type | Default |
|---|
event | String | — |
args (optional) | Array<Dynamic> | null |
ignoreStops (optional) | Dynamic | true |
exclusions (optional) | Array<String> | null |
excludeValues (optional) | Array<Dynamic> | null |
View source
setOnScripts
function setOnScripts(variable:String, arg:Dynamic)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
variable | String | — |
arg | Dynamic | — |
View source
setOnLuas
function setOnLuas(variable:String, arg:Dynamic)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
Kept for compatibility: dispatches to Lua, Python and HScript scripts.
| Parameter | Type | Default |
|---|
variable | String | — |
arg | Dynamic | — |
View source
callOnHScript
function callOnHScript(event:String, args:Array<Dynamic> = null):Dynamic
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if HSCRIPT_ALLOWED.
Dispatch a callback to standalone HScript scripts only.
| Parameter | Type | Default |
|---|
event | String | — |
args (optional) | Array<Dynamic> | null |
View source
setOnHScript
function setOnHScript(variable:String, arg:Dynamic)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end + #if HSCRIPT_ALLOWED.
Publish a variable to standalone HScript scripts only.
| Parameter | Type | Default |
|---|
variable | String | — |
arg | Dynamic | — |
View source
RecalculateRating
function RecalculateRating(badHit:Bool = false)
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
| Parameter | Type | Default |
|---|
badHit (optional) | Bool | false |
View source
stopRender
static function stopRender():Void
Only compiled when #if DISCORD_ALLOWED DiscordClient.resetClientID(); #end.
View source
Internals
Private / internal members
| Field | Type | Static |
|---|
singAnimations | Array<String> | no |
tauntKey | Array<FlxKey> | no |
lastUpdateTime | Float | no |
isCameraOnForcedPos | Bool | no |
botplayUsed | Bool | no |
curTime | Float | no |
songCalc | Float | no |
strumsHit | Array<Bool> | no |
intro3 | FlxSound | no |
intro2 | FlxSound | no |
intro1 | FlxSound | no |
introGo | FlxSound | no |
tankmanAscend | Bool | no |
prevCamFollow | FlxPoint | yes |
prevCamFollowPos | FlxObject | yes |
curSong | String | no |
displayedHealth | Float | no |
notesAddedCount | Int | no |
eventIndex | Int | no |
notesToRemoveCount | Int | no |
oppNotesToRemoveCount | Int | no |
endingTimeLimit | Int | no |
camBopFactor | Float | no |
camBopInterval | Float | no |
camBopIntensity | Float | no |
twistModifier | Float | no |
twistAmount | Float | no |
camTwistIntensity | Float | no |
camTwistIntensity2 | Float | no |
camTwist | Bool | no |
healthBarBG | AttachedSprite | no |
songPercent | Float | no |
timeBarBG | AttachedSprite | no |
energyBarBG | AttachedSprite | no |
pixelRatingPrefix | String | no |
pixelRatingSuffix | String | no |
lerpingScore | Bool | no |
generatedMusic | Bool | no |
updateTime | Bool | no |
charChangeTimes | Array<Float> | no |
charChangeNames | Array<String> | no |
charChangeTypes | Array<Int> | no |
multiChangeEvents | Array<Array<Float>> | no |
randomMode | Bool | no |
flip | Bool | no |
stairs | Bool | no |
waves | Bool | no |
oneK | Bool | no |
randomSpeedThing | Bool | no |
layoutWidth | Int | no |
hitsoundImage | FlxSprite | no |
hitsoundImageToLoad | String | no |
notesHitArray | Array<Float> | no |
oppNotesHitArray | Array<Float> | no |
notesHitDateArray | Array<Float> | no |
oppNotesHitDateArray | Array<Float> | no |
dialogue | Array<String> | no |
dialogueJson | DialogueFile | no |
EngineWatermark | FlxText | no |
disableTheTripper | Bool | no |
disableTheTripperAt | Int | no |
heyTimer | Float | no |
timeTxt | FlxText | no |
scoreTxtTween | FlxTween | no |
_defaultCamZoom | Float | no |
songLength | Float | no |
heyStopTrying | Bool | no |
storyDifficultyText | String | no |
detailsText | String | no |
detailsPausedText | String | no |
keysPressed | Array<Bool> | no |
boyfriendIdleTime | Float | no |
boyfriendIdled | Bool | no |
luaDebugGroup | FlxTypedGroup<DebugLuaText> | no |
pythonDebugGroup | FlxTypedGroup<DebugLuaText> | no |
hscriptDebugGroup | FlxTypedGroup<DebugLuaText> | no |
debugKeysChart | Array<FlxKey> | no |
debugKeysCharacter | Array<FlxKey> | no |
keysArray | Array<Dynamic> | no |
controlArray | Array<String> | no |
formattedScore | String | no |
formattedSongMisses | String | no |
formattedCombo | String | no |
formattedMaxCombo | String | no |
formattedNPS | String | no |
formattedMaxNPS | String | no |
formattedOppNPS | String | no |
formattedMaxOppNPS | String | no |
npsString | String | no |
accuracy | String | no |
fcString | String | no |
hitsound | FlxSound | no |
botText | String | no |
tempScore | String | no |
startingTime | Float | no |
endingTime | Float | no |
ffmpegMode | — | no |
targetFPS | — | no |
unlockFPS | — | no |
renderGCRate | — | no |
capture | Screenshot | yes |
dialogueCount | Int | no |
startTimer | FlxTimer | no |
finishTimer | FlxTimer | no |
comboInfo | — | no |
showNPS | — | no |
missString | String | no |
ogSongSpeed | Float | no |
stair | Int | no |
firstNoteData | Int | no |
assignedFirstData | Bool | no |
noteTypeMap | Map<String, Bool> | no |
eventPushedMap | Map<String, Bool> | no |
startedCountdown | Bool | no |
canPause | Bool | no |
noteLimit | — | no |
limitNC | — | no |
canUseBotEnergy | Bool | no |
usingBotEnergy | Bool | no |
noEnergy | Bool | no |
holdingBotEnergyBind | Bool | no |
strumsHeld | Array<Bool> | no |
strumHeldAmount | Int | no |
holdArray | Array<Bool> | no |
hardwareHeld | Array<Bool> | no |
hardwareKeyHandler | Int->Bool->Void = null | no |
pressArray | Array<Bool> | no |
releaseArray | Array<Bool> | no |
notesBeingHit | Bool | no |
notesBeingMissed | Bool | no |
hitResetTimer | Float | no |
missResetTimer | Float | no |
botEnergyCooldown | Float | no |
energyDrainSpeed | Float | no |
energyRefillSpeed | Float | no |
iconSizeResetTime | Float | no |
percent | Float | no |
center | Float | no |
cameraTwn | FlxTween | no |
rating | Popup | no |
numScore | Popup | no |
daRating | Rating | no |
noteDiff | — | no |
separatedScore | Array<Dynamic> | no |
NOTE_SPAWN_TIME | Float | no |
targetNote | PreloadedChartNote | no |
spawnedNote | Note | no |
oppTrigger | Bool | no |
doGf | Bool | no |
playerChar | — | no |
canPlay | — | no |
holdAnim | String | no |
animToPlay | String | no |
animCheck | String | no |
oppChar | — | no |
gfTrigger | Bool | no |
noteKill | Note | no |
lastBeatHit | Int | no |
twisted | — | no |
usingBopIntervalEvent | — | no |
curLight | Int | no |
curLightEvent | Int | no |
ffmpegExists | Bool | no |
renderWidth | Int | no |
renderHeight | Int | no |
img | — | no |
bytes | — | no |
| Method |
|---|
static function get_isPixelStage():Bool |
inline function set_cpuControlled(value:Bool) |
inline function set_songSpeed(value:Float):Float |
inline function set_playbackRate(value:Float):Float |
inline function set_polyphony(value:Float, which:Int):Float |
inline function get_defaultCamZoom():Float |
inline function set_defaultCamZoom(value:Float):Float |
function startCharacterLua(name:String) |
function startCharacterPos(char:Character, gfCheck:Bool = false) |
function cacheCountdown() |
inline function createCountdownSprite(image:String, antialias:Bool):FlxSprite |
function startSong():Void |
function generateSong(startingPoint:Float = 0):Void |
function eventPushed(event:EventNote) |
function eventPushedUnique(event:EventNote) |
function eventNoteEarlyTrigger(event:EventNote):Float |
function sortByTime(Obj1:Dynamic, Obj2:Dynamic):Int |
function sortNotesByTime(Obj1:Note, Obj2:Note):Int |
function generateStaticArrows(player:Int):Void |
override function openSubState(SubState:flixel.FlxSubState) |
override function closeSubState() |
function resetRPC(showTime:Bool = false) |
function resyncVocals():Void |
function openPauseMenu() |
function openChartEditor() |
function doDeathCheck(skipHealthCheck:Bool = false) |
function sendWindowsNotification(title:String, desc:String, isEvent:Bool = false) |
function snapCamFollowToPos(x:Float, y:Float) |
function calculateTrollModeStuff(pb:Float):Float |
function calculateResetTime():Float |
function cachePopUpScore() |
function judgeNote(note:Note = null, miss:Bool = false) |
function popUpScore(note:Note = null, miss:Bool = false):Void |
function onKeyPress(event:KeyboardEvent):Void |
function keyPressed(key:Int):Void |
function sortHitNotes(a:Dynamic, b:Dynamic):Int |
function onKeyRelease(event:KeyboardEvent):Void |
function onHardwareKey(keyCode:Int, down:Bool):Void |
function keyReleased(key:Int) |
function handleKeyInput():Void |
function noteMiss(daNote:Note = null, daNoteAlt:PreloadedChartNote = null):Void |
function noteMissPress(direction:Int = 1):Void //You pressed a key when there was no notes to press for this key |
function spawnNotes() |
function updateNote(daNote:Note):Void |
function goodNoteHit(note:Note, noteAlt:PreloadedChartNote = null):Void |
function opponentNoteHit(daNote:Note, noteAlt:PreloadedChartNote = null):Void |
override function destroy() |
override function stepHit() |
override function beatHit() |
override function sectionHit() |
function StrumPlayAnim(isDad:Bool, id:Int, time:Float) |
function checkForAchievement(achievesToCheck:Array<String> = null) |
function initRender(renderPath:String = "assets/gameRenders/", prefixName:String = null):Void |
function pipeFrame():Void |