Gets the actor object of the scene
Returns:
| Name | Type | Description |
|---|
window | Window | The window to add as a child |
arePageButtonsEnabled()boolean
Check if page buttons should be enabled
Returns:
| Type | Description |
|---|
| boolean | True if page buttons should be enabled |
Gets the bottom of the touch UI button area in the scene
Returns:
| Type | Description |
|---|
| number | Y Pixel for the cottom coordinate of the button area |
Gets the height of the touch UI button area
Returns:
| Type | Description |
|---|
| number | Height in pixels of the button area |
Gets the top of the touch UI button area in the scene
Returns:
| Type | Description |
|---|
| number | Y Pixel for the top coordinate of the button area |
Gets the Y pixel of the buttons
Returns:
| Type | Description |
|---|
| number | Y Pixel for the top coordinate of the buttons |
calcWindowHeight(numLines, selectable)numberinherited
Calculates how many pixels tall a window is
| Name | Type | Description |
|---|
numLines | number | Amount of text lines in the window |
selectable | boolean | If the window is selectable (or inherits from Window_Selectable) or not |
Returns:
| Type | Description |
|---|
| number | Amount of pixels tall the window is |
Centers a given sprite within the game window
| Name | Type | Description |
|---|
sprite | Sprite | The sprite to center |
Check if there is a gameover, and go to Scene_Gameover if so
Creates the scene
Create the background image for the scene
Creates the Touch UI buttons
Creates the cancel button
Create the scene's help window
Creates the page up/down buttons
Destroys the stage
Try to autosave the game
Fades out the scene and audio
Default speed for a normal fade
Returns:
| Type | Description |
|---|
| number | Amount of frames to fade |
Gets the bottom of the help area
Returns:
| Type | Description |
|---|
| number | Y Pixel for the bottom coordinate of the help area |
Gets the height needed for the help area
Returns:
| Type | Description |
|---|
| number | Number of pixels tall the help area is |
Gets the top of the help area
Returns:
| Type | Description |
|---|
| number | Y Pixel for the top coordinate of the help area |
Get the Rectangle object that provides the help window's x/y/width/height
Returns:
| Type | Description |
|---|
| Rectangle | The rectangle representing the help window |
Initializes the scene
Check if scene is active
Returns:
| Type | Description |
|---|
| boolean | True if the scene is active |
Check if autosaving is enabled
Returns:
| Type | Description |
|---|
| boolean | True if the game can autosave |
Check if touch UI buttons appear on bottom
Returns:
| Type | Description |
|---|
| boolean | True if bottom button mode is enabled |
Check if the help window appears on bottom
Returns:
| Type | Description |
|---|
| boolean | True if bottom help mode is enabled |
Check if scene is busy
Returns:
| Type | Description |
|---|
| boolean | True if the scene is busy |
Check if scene is currently fading the screen
Returns:
| Type | Description |
|---|
| boolean | True if the scene is fading |
Check if scene is ready
Returns:
| Type | Description |
|---|
| boolean | True if the scene is ready |
Check if right input mode is enabled
Returns:
| Type | Description |
|---|
| boolean | True if right input mode is enabled |
Check if scene is started
Returns:
| Type | Description |
|---|
| boolean | True if the scene is started |
Gets the bottom of the main area
Returns:
| Type | Description |
|---|
| number | Y Pixel for the bottom coordinate of the main area |
Gets the total height of the main area in pixels
Returns:
| Type | Description |
|---|
| number | Total height of the main area |
Gets the top of the main area
Returns:
| Type | Description |
|---|
| number | Y Pixel for the top coordinate of the main area |
Get the main command width
Returns:
| Type | Description |
|---|
| number | Width of a main command |
Check if the scene should create the cancel button
Returns:
| Type | Description |
|---|
| boolean | True if there should be a cancel button in the scene |
needsPageButtons()boolean
Check if the scene should create the page buttons
Returns:
| Type | Description |
|---|
| boolean | True if there should be page buttons in the scene |
Cycle to the next actor in the menu
Processing for when the scene's actor changes
Processing for when an autosave attempt failed
Processing for when an autosave attempt was successful
Pops the scene to return to the previous scene
Cycle to the previous actor in the menu
Requests an autosave
Scales a given sprite to fit in the game window
| Name | Type | Description |
|---|
sprite | Sprite | The sprite to scale |
setBackgroundOpacity(opacity)
Set the background image opacity
| Name | Type | Description |
|---|
opacity | number | The opacity to set the background image to |
Default speed for a slow fade
Returns:
| Type | Description |
|---|
| number | Amount of frames to fade |
Starts the scene
Start to fade the scene in
| Name | Type | Description |
|---|
duration | number | Frames to fade in the scene |
white | boolean | If the fade color is white or not |
Start to fade the scene out
| Name | Type | Description |
|---|
duration | number | Frames to fade out the scene |
white | boolean | If the fade color is white or not |
Stops the scene
Terminates the scene
Updates the scene
Sets the actor object of the scene
Updates the scene's children
Updates the scene's fade
Updates the page up / down buttons visibility