Class: Scene_Base

Scene_Base

new Scene_Base()

The superclass of all scenes within the game.

Extends

Methods

addWindow(window)

Adds a window to the scene's WindowLayer
NameTypeDescription
windowWindowThe window to add as a child

buttonAreaBottom()number

Gets the bottom of the touch UI button area in the scene
Returns:
TypeDescription
numberY Pixel for the cottom coordinate of the button area

buttonAreaHeight()number

Gets the height of the touch UI button area
Returns:
TypeDescription
numberHeight in pixels of the button area

buttonAreaTop()number

Gets the top of the touch UI button area in the scene
Returns:
TypeDescription
numberY Pixel for the top coordinate of the button area

buttonY()number

Gets the Y pixel of the buttons
Returns:
TypeDescription
numberY Pixel for the top coordinate of the buttons

calcWindowHeight(numLines, selectable)number

Calculates how many pixels tall a window is
NameTypeDescription
numLinesnumberAmount of text lines in the window
selectablebooleanIf the window is selectable (or inherits from Window_Selectable) or not
Returns:
TypeDescription
numberAmount of pixels tall the window is

centerSprite(sprite)

Centers a given sprite within the game window
NameTypeDescription
spriteSpriteThe sprite to center

checkGameover()

Check if there is a gameover, and go to Scene_Gameover if so
Creates the scene

createColorFilter()

Creates the scene's ColorFilter

createWindowLayer()

Create the scene's WindowLayer
Destroys the stage

executeAutosave()

Try to autosave the game

fadeOutAll()

Fades out the scene and audio

fadeSpeed()number

Default speed for a normal fade
Returns:
TypeDescription
numberAmount of frames to fade
Initializes the scene

isActive()boolean

Check if scene is active
Returns:
TypeDescription
booleanTrue if the scene is active

isAutosaveEnabled()boolean

Check if autosaving is enabled
Returns:
TypeDescription
booleanTrue if the game can autosave

isBottomButtonMode()boolean

Check if touch UI buttons appear on bottom
Returns:
TypeDescription
booleanTrue if bottom button mode is enabled

isBottomHelpMode()boolean

Check if the help window appears on bottom
Returns:
TypeDescription
booleanTrue if bottom help mode is enabled

isBusy()boolean

Check if scene is busy
Returns:
TypeDescription
booleanTrue if the scene is busy

isFading()boolean

Check if scene is currently fading the screen
Returns:
TypeDescription
booleanTrue if the scene is fading

isReady()boolean

Check if scene is ready
Returns:
TypeDescription
booleanTrue if the scene is ready

isRightInputMode()boolean

Check if right input mode is enabled
Returns:
TypeDescription
booleanTrue if right input mode is enabled

isStarted()boolean

Check if scene is started
Returns:
TypeDescription
booleanTrue if the scene is started

mainCommandWidth()number

Get the main command width
Returns:
TypeDescription
numberWidth of a main command

onAutosaveFailure()

Processing for when an autosave attempt failed

onAutosaveSuccess()

Processing for when an autosave attempt was successful
Pops the scene to return to the previous scene

requestAutosave()

Requests an autosave

scaleSprite(sprite)

Scales a given sprite to fit in the game window
NameTypeDescription
spriteSpriteThe sprite to scale

slowFadeSpeed()number

Default speed for a slow fade
Returns:
TypeDescription
numberAmount of frames to fade
Starts the scene

startFadeIn(duration, white)

Start to fade the scene in
NameTypeDescription
durationnumberFrames to fade in the scene
whitebooleanIf the fade color is white or not

startFadeOut(duration, white)

Start to fade the scene out
NameTypeDescription
durationnumberFrames to fade out the scene
whitebooleanIf the fade color is white or not
Stops the scene
Terminates the scene
Updates the scene

updateChildren()

Updates the scene's children

updateColorFilter()

Updates the scene's ColorFilter

updateFade()

Updates the scene's fade