Class: Scene_Boot

Scene_Boot

new Scene_Boot()

The scene class for initializing the entire game.

Extends

Methods

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

adjustBoxSize()

Adjusts the width and height of the UI area of the game

adjustWindow()

Adjusts the width and height of the game screen

buttonAreaBottom()numberinherited

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()numberinherited

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

buttonAreaTop()numberinherited

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

calcWindowHeight(numLines, selectable)numberinherited

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)inherited

Centers a given sprite within the game window
NameTypeDescription
spriteSpriteThe sprite to center
Check if there is a gameover, and go to Scene_Gameover if so

checkPlayerLocation()

Check for the player's starting location
Throws:
Error if the player has no starting location
Creates the scene

createColorFilter()inherited

Creates the scene's ColorFilter

createWindowLayer()inherited

Create the scene's WindowLayer
Destroys the stage
Try to autosave the game
Fades out the scene and audio
Default speed for a normal fade
Returns:
TypeDescription
numberAmount of frames to fade
Initializes the scene

isActive()booleaninherited

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

isAutosaveEnabled()booleaninherited

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

isBottomButtonMode()booleaninherited

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

isBottomHelpMode()booleaninherited

Check if the help window appears on bottom
Returns:
TypeDescription
booleanTrue if bottom help mode is enabled
Check if scene is busy
Returns:
TypeDescription
booleanTrue if the scene is busy
Check if scene is currently fading the screen
Returns:
TypeDescription
booleanTrue if the scene is fading

isPlayerDataLoaded()boolean

Check if player data is loaded
Returns:
TypeDescription
booleanTrue if player data is done loading
Check if scene is ready
Returns:
TypeDescription
booleanTrue if the scene is ready

isRightInputMode()booleaninherited

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

isStarted()booleaninherited

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

loadGameFonts()

Loads the game fonts

loadPlayerData()

Loads player data

loadSystemImages()

Loads some system images

mainCommandWidth()numberinherited

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

onAutosaveFailure()inherited

Processing for when an autosave attempt failed

onAutosaveSuccess()inherited

Processing for when an autosave attempt was successful

onDatabaseLoaded()

Processing for when the database is done loading
Pops the scene to return to the previous scene
Requests an autosave

resizeScreen()

Resize the game window to the resolution set in the database

scaleSprite(sprite)inherited

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

screenScale()number

Get the screen scale parameter
Since:
  • Version 1.6.0
Returns:
TypeDescription
numberThe screen scale parameter

setEncryptionInfo()

Check what is encrypted (if any) and set encryption info

slowFadeSpeed()numberinherited

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

startFadeIn(duration, white)inherited

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

startFadeOut(duration, white)inherited

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

startNormalGame()

Processing when starting a normal game
Stops the scene
Terminates the scene
Updates the scene
Updates the scene's children

updateColorFilter()inherited

Updates the scene's ColorFilter

updateDocumentTitle()

Updates the html title of the game window
Updates the scene's fade