BaseStage
| Kind | class |
| Package | play |
| Full name | play.BaseStage |
| Source | source/play/BaseStage.hx |
| Extends | FlxBasic |
Known subclasses: Limo, Mall, MallEvil, Philly, PhillyBlazin, PhillyStreets, PhillyStreetsBF, School, SchoolEvil, Spooky, StageWeek1, Tank, Template
Public fields
| Name | Type | Static | Default | Notes |
|---|---|---|---|---|
onPlayState | Bool | no | false | — |
paused | Bool | no | — | property (get, never) · some variables for convenience |
songName | String | no | — | property (get, never) |
isStoryMode | Bool | no | — | property (get, never) |
seenCutscene | Bool | no | — | property (get, never) |
inCutscene | Bool | no | — | property (get, set) |
canPause | Bool | no | — | property (get, set) |
members | Dynamic | no | — | property (get, never) |
boyfriend | Character | no | — | property (get, never) |
dad | Character | no | — | property (get, never) |
gf | Character | no | — | property (get, never) |
boyfriendGroup | FlxSpriteGroup | no | — | property (get, never) |
dadGroup | FlxSpriteGroup | no | — | property (get, never) |
gfGroup | FlxSpriteGroup | no | — | property (get, never) |
camGame | FlxCamera | no | — | property (get, never) |
camHUD | FlxCamera | no | — | property (get, never) |
camOther | FlxCamera | no | — | property (get, never) |
defaultCamZoom | Float | no | — | property (get, set) |
camFollow | FlxPoint | no | — | property (get, never) |
camFollowPos | FlxObject | no | — | property (get, never) |
curBeat | Int | no | 0 | FNF steps, beats and sections |
curDecBeat | Float | no | 0 | — |
curStep | Int | no | 0 | — |
curDecStep | Float | no | 0 | — |
curSection | Int | no | 0 | — |
Public methods
new (constructor)
function new()
create
function create()
main callbacks
createPost
function createPost()
onViewportResize
function onViewportResize()
Reflow full-screen stage effects when the logical viewport changes.
countdownTick
function countdownTick(count:Countdown, num:Int)
public function update(elapsed:Float) {}
| Parameter | Type | Default |
|---|---|---|
count | Countdown | — |
num | Int | — |
startSong
function startSong()
beatHit
function beatHit()
stepHit
function stepHit()
sectionHit
function sectionHit()
closeSubState
function closeSubState()
Substate close/open, for pausing Tweens/Timers
openSubState
function openSubState(SubState:FlxSubState)
| Parameter | Type | Default |
|---|---|---|
SubState | FlxSubState | — |
eventCalled
function eventCalled(eventName:String, value1:String, value2:String, flValue1:Null<Float>, flValue2:Null<Float>, strumTime:Float)
Events
| Parameter | Type | Default |
|---|---|---|
eventName | String | — |
value1 | String | — |
value2 | String | — |
flValue1 | Null<Float> | — |
flValue2 | Null<Float> | — |
strumTime | Float | — |
eventPushed
function eventPushed(event:EventNote)
| Parameter | Type | Default |
|---|---|---|
event | EventNote | — |
eventPushedUnique
function eventPushedUnique(event:EventNote)
| Parameter | Type | Default |
|---|---|---|
event | EventNote | — |
goodNoteHit
function goodNoteHit(note:Note)
Note Hit/Miss
| Parameter | Type | Default |
|---|---|---|
note | Note | — |
opponentNoteHit
function opponentNoteHit(note:Note)
| Parameter | Type | Default |
|---|---|---|
note | Note | — |
noteMiss
function noteMiss(note:Note)
| Parameter | Type | Default |
|---|---|---|
note | Note | — |
noteMissPress
function noteMissPress(direction:Int)
| Parameter | Type | Default |
|---|---|---|
direction | Int | — |
onGameOver
function onGameOver()
Game Over
addBehindGF
function addBehindGF(obj:FlxBasic)
| Parameter | Type | Default |
|---|---|---|
obj | FlxBasic | — |
addBehindBF
function addBehindBF(obj:FlxBasic)
| Parameter | Type | Default |
|---|---|---|
obj | FlxBasic | — |
addBehindDad
function addBehindDad(obj:FlxBasic)
| Parameter | Type | Default |
|---|---|---|
obj | FlxBasic | — |
setDefaultGF
function setDefaultGF(name:String)
| Parameter | Type | Default |
|---|---|---|
name | String | — |
setStartCallback
function setStartCallback(myfn:Void->Void)
start/end callback functions
| Parameter | Type | Default |
|---|---|---|
myfn | Void->Void | — |
setEndCallback
function setEndCallback(myfn:Void->Void)
| Parameter | Type | Default |
|---|---|---|
myfn | Void->Void | — |
Internals
Private / internal members
| Field | Type | Static |
|---|---|---|
game | Dynamic | no |
| 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 |