Skip to main content

BaseStage

Kindclass
Packageplay
Full nameplay.BaseStage
Sourcesource/play/BaseStage.hx
ExtendsFlxBasic

Known subclasses: Limo, Mall, MallEvil, Philly, PhillyBlazin, PhillyStreets, PhillyStreetsBF, School, SchoolEvil, Spooky, StageWeek1, Tank, Template

Public fields​

NameTypeStaticDefaultNotes
onPlayStateBoolnofalse—
pausedBoolno—property (get, never) · some variables for convenience
songNameStringno—property (get, never)
isStoryModeBoolno—property (get, never)
seenCutsceneBoolno—property (get, never)
inCutsceneBoolno—property (get, set)
canPauseBoolno—property (get, set)
membersDynamicno—property (get, never)
boyfriendCharacterno—property (get, never)
dadCharacterno—property (get, never)
gfCharacterno—property (get, never)
boyfriendGroupFlxSpriteGroupno—property (get, never)
dadGroupFlxSpriteGroupno—property (get, never)
gfGroupFlxSpriteGroupno—property (get, never)
camGameFlxCamerano—property (get, never)
camHUDFlxCamerano—property (get, never)
camOtherFlxCamerano—property (get, never)
defaultCamZoomFloatno—property (get, set)
camFollowFlxPointno—property (get, never)
camFollowPosFlxObjectno—property (get, never)
curBeatIntno0FNF steps, beats and sections
curDecBeatFloatno0—
curStepIntno0—
curDecStepFloatno0—
curSectionIntno0—

Public methods​

new (constructor)​

function new()

View source

create​

function create()

main callbacks

View source

createPost​

function createPost()

View source

onViewportResize​

function onViewportResize()

Reflow full-screen stage effects when the logical viewport changes.

View source

countdownTick​

function countdownTick(count:Countdown, num:Int)

public function update(elapsed:Float) {}

ParameterTypeDefault
countCountdown—
numInt—

View source

startSong​

function startSong()

View source

beatHit​

function beatHit()

View source

stepHit​

function stepHit()

View source

sectionHit​

function sectionHit()

View source

closeSubState​

function closeSubState()

Substate close/open, for pausing Tweens/Timers

View source

openSubState​

function openSubState(SubState:FlxSubState)
ParameterTypeDefault
SubStateFlxSubState—

View source

eventCalled​

function eventCalled(eventName:String, value1:String, value2:String, flValue1:Null<Float>, flValue2:Null<Float>, strumTime:Float)

Events

ParameterTypeDefault
eventNameString—
value1String—
value2String—
flValue1Null<Float>—
flValue2Null<Float>—
strumTimeFloat—

View source

eventPushed​

function eventPushed(event:EventNote)
ParameterTypeDefault
eventEventNote—

View source

eventPushedUnique​

function eventPushedUnique(event:EventNote)
ParameterTypeDefault
eventEventNote—

View source

goodNoteHit​

function goodNoteHit(note:Note)

Note Hit/Miss

ParameterTypeDefault
noteNote—

View source

opponentNoteHit​

function opponentNoteHit(note:Note)
ParameterTypeDefault
noteNote—

View source

noteMiss​

function noteMiss(note:Note)
ParameterTypeDefault
noteNote—

View source

noteMissPress​

function noteMissPress(direction:Int)
ParameterTypeDefault
directionInt—

View source

onGameOver​

function onGameOver()

Game Over

View source

addBehindGF​

function addBehindGF(obj:FlxBasic)
ParameterTypeDefault
objFlxBasic—

View source

addBehindBF​

function addBehindBF(obj:FlxBasic)
ParameterTypeDefault
objFlxBasic—

View source

addBehindDad​

function addBehindDad(obj:FlxBasic)
ParameterTypeDefault
objFlxBasic—

View source

setDefaultGF​

function setDefaultGF(name:String)
ParameterTypeDefault
nameString—

View source

setStartCallback​

function setStartCallback(myfn:Void->Void)

start/end callback functions

ParameterTypeDefault
myfnVoid->Void—

View source

setEndCallback​

function setEndCallback(myfn:Void->Void)
ParameterTypeDefault
myfnVoid->Void—

View source

Internals​

Private / internal members
FieldTypeStatic
gameDynamicno
Method
function add(object:FlxBasic)
function remove(object:FlxBasic)
function insert(position:Int, object:FlxBasic)
function startCountdown()
function endSong()
function moveCameraSection()
function moveCamera(focus:String = 'bf')
inline function get_paused()
inline function get_songName()
inline function get_isStoryMode()
inline function get_seenCutscene()
inline function get_inCutscene()
inline function set_inCutscene(value:Bool)
inline function get_canPause()
inline function set_canPause(value:Bool)
inline function get_members()
inline function set_game(value:MusicBeatState)
inline function get_boyfriend():Character return game.boyfriend
inline function get_dad():Character return game.dad
inline function get_gf():Character return game.gf
inline function get_boyfriendGroup():FlxSpriteGroup return game.boyfriendGroup
inline function get_dadGroup():FlxSpriteGroup return game.dadGroup
inline function get_gfGroup():FlxSpriteGroup return game.gfGroup
inline function get_camGame():FlxCamera return game.camGame
inline function get_camHUD():FlxCamera return game.camHUD
inline function get_camOther():FlxCamera return game.camOther
inline function get_defaultCamZoom():Float return PlayState.instance.defaultCamZoom
inline function set_defaultCamZoom(value:Float):Float
inline function get_camFollow():FlxPoint return game.camFollow
inline function get_camFollowPos():FlxObject return game.camFollowPos