Activates the window
Gets an actor name from their id
| Name | Type | Description |
|---|
n | number | Actor id |
Returns:
| Type | Description |
|---|
| string | The actor's name |
Gets the name of an equip slot at an index
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
index | number | The index of the equip slot |
Returns:
| Type | Description |
|---|
| string | The name of the equip type for that slot |
Adds a child between the background and contents
| Name | Type | Description |
|---|
child | object | The child to add |
Returns:
| Type | Description |
|---|
| object | The child that was added |
Adds a child to the client area
| Name | Type | Description |
|---|
child | object | The child to add |
Returns:
| Type | Description |
|---|
| object | The child that was added |
Creates a rectangle for an item of text
Returns:
| Type | Description |
|---|
| Rectangle | Rectangle that encompasses the text item |
Calculates the height of the text in a text state
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| string | The height of the text |
Calls the cancel handler function
Calls a handler function
| Name | Type | Description |
|---|
symbol | string | The id (or symbol) of the function |
Calls the ok handler function
Calls the updateHelp function if the window is active and there is a help window
Changes the text outline color of text drawn to the window
| Name | Type | Description |
|---|
color | string | The new outline color to use |
Changes the opacity of what is painted to the contents of the window
| Name | Type | Description |
|---|
enabled | boolean | True = use full opacity | False = use translucent opacity |
Changes the text color of text drawn to the window
| Name | Type | Description |
|---|
color | string | The new color to draw text in |
Checks if the given rect parameter is a valid
Rectangle| Name | Type | Description |
|---|
rect | * | The object to check for validity |
Throws:
Error if the object is not a valid rectangle
Returns:
| Type | Description |
|---|
| boolean | True if the object is a valid rectangle |
Clears the item at the given index
| Name | Type | Description |
|---|
index | number | The index of the item to clear |
Clears scrolling status to defaults
Start closing the window
Get the spacing between columns
Returns:
| Type | Description |
|---|
| number | Spacing between columns |
Get the height of the contents
Returns:
| Type | Description |
|---|
| number | Contents height |
Gets the width needed for the window contents
Returns:
| Type | Description |
|---|
| number | Width needed for the window contents |
Converts escape code characters in text, for example \v[x]
| Name | Type | Description |
|---|
text | string | The text to convert |
Returns:
| Type | Description |
|---|
| string | Text with escape characters converted |
Creates the contents of the window
Creates the background dimmer sprite
Creates a sprite as an inner child
| Name | Type | Description |
|---|
key | string | The key used to refer to the sprite after creation |
spriteClass | Sprite | The sprite class to create |
Returns:
| Type | Description |
|---|
| Sprite | The created sprite |
Creates a text buffer
| Name | Type | Description |
|---|
rtl | boolean | If the text is right to left (such as arabic text) |
Returns:
| Type | Description |
|---|
| string | The buffer for text embedding either right to left or left to right |
createTextState(text, x, y, width)Objectinherited
Creates a text state object for drawing text with text codes
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to draw the text |
y | number | The y coordinate to draw the text |
width | number | The width of the text |
Returns:
| Type | Description |
|---|
| Object | The text state object |
Get the cursor all flag
Returns:
| Type | Description |
|---|
| boolean | The cursor all flag |
Handling for when the cursor moves down
| Name | Type | Description |
|---|
wrap | boolean | If the cursor should wrap |
Gheck if the cursor is fixed
Returns:
| Type | Description |
|---|
| boolean | True if the cursor is fixed |
Handling for when the cursor moves left
| Name | Type | Description |
|---|
wrap | boolean | If the cursor should wrap |
Handling for when the cursor moves by pagedown
Handling for when the cursor moves by pageup
Handling for when the cursor moves right
| Name | Type | Description |
|---|
wrap | boolean | If the cursor should wrap |
Handling for when the cursor moves up
| Name | Type | Description |
|---|
wrap | boolean | If the cursor should wrap |
Deactivates the window
Deselects from the window
Destroys the window
Destroys the contents of the window
Draws the actor's character sprite
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to draw the sprite |
y | number | The y coordinate to draw the sprite |
Draws the actor's class
| Name | Type | Default | Description |
|---|
actor | Game_Actor | | The Game Actor object |
x | number | | The x coordinate to draw the text |
y | number | | The y coordinate to draw the text |
width | number | 168 | optionalThe max width of the class |
drawActorFace(actor, x, y, width, height)inherited
Draws the actor's face sprite
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to draw the sprite |
y | number | The y coordinate to draw the sprite |
width | number | The width of the sprite |
height | number | The height of the sprite |
Draws the actor's icons
| Name | Type | Default | Description |
|---|
actor | Game_Actor | | The Game Actor object |
x | number | | The x coordinate to draw the icons |
y | number | | The y coordinate to draw the icons |
width | number | 144 | optionalThe max width available to display icons in |
Draws the actor's level
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to draw the text |
y | number | The y coordinate to draw the text |
Draws the actor's name
| Name | Type | Default | Description |
|---|
actor | Game_Actor | | The Game Actor object |
x | number | | The x coordinate to draw the text |
y | number | | The y coordinate to draw the text |
width | number | 168 | optionalThe max width of the name |
drawActorNickname(actor, x, y, width)inherited
Draws the actor's nickname
| Name | Type | Default | Description |
|---|
actor | Game_Actor | | The Game Actor object |
x | number | | The x coordinate to draw the text |
y | number | | The y coordinate to draw the text |
width | number | 270 | optionalThe max width of the nickname |
Draws simple status elements for an actor, including name/level/icons/class/gauges
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to draw the status |
y | number | The y coordinate to draw the status |
Draws all the items
Draws a background rect
| Name | Type | Description |
|---|
rect | Rectangle | The rectangle for where to draw the background |
drawCharacter(characterName, characterIndex, x, y)inherited
Draws a character at x/y coordinates
| Name | Type | Description |
|---|
characterName | string | The name of the character sheet bitmap |
characterIndex | number | The index of the character on the sheet |
x | number | The x coordinate |
y | number | The y coordinate |
drawCurrencyValue(value, unit, x, y, width)inherited
Draws a currency value
| Name | Type | Description |
|---|
value | number | The amount of currency |
unit | string | The currency unit |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width available to draw the item name |
drawFace(faceName, faceIndex, x, y, width, height)inherited
Draws a face at x/y coordinates with width/height
| Name | Type | Description |
|---|
faceName | string | The name of the face sheet bitmap |
faceIndex | number | The index of the face on the sheet |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width of the face |
height | number | The height of the face |
Draws an icon at x/y coordinates
| Name | Type | Description |
|---|
iconIndex | number | The index of the icon to draw |
x | number | The x coordinate |
y | number | The y coordinate |
Draws the item info at the given index
| Name | Type | Description |
|---|
index | number | The index to draw |
Draws the item background
Draws an item's name with its icon
| Name | Type | Description |
|---|
item | Object | The item object to draw, must at least have iconIndex and name properties |
x | number | The x coordinate |
y | number | The y coordinate |
width | number | The width available to draw the item name |
Draws a rectangle of given width/height at given x/y coordinates
| Name | Type | Description |
|---|
x | number | The X coordinate of the upper left corner of the rectangle |
y | number | The Y coordinate of the upper left corner of the rectangle |
width | number | The width in pixels of the rectangle |
height | number | The height in pixels of the rectangle |
Draws the window shape into PIXI.Graphics object. Used by WindowLayer
drawText(text, x, y, maxWidth, align)inherited
Draws text to the window's contents. Does not support text codes in the text, but will fit the text within the maximum width without overflowing.
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to begin drawing the text |
y | number | The y coordinate to begin drawing the text |
maxWidth | number | The maximum width in pixels of the text |
align | string | The alignment of the text |
Draws text to the window's contents. Does support text codes.
| Name | Type | Description |
|---|
text | string | The text to draw |
x | number | The x coordinate to draw the text |
y | number | The y coordinate to draw the text |
width | number | The width of the text |
Returns:
| Type | Description |
|---|
| number | The width of the drawn text |
Ensure the cursor is visible by scrolling if needed
| Name | Type | Description |
|---|
smooth | boolean | Whether to smooth scroll if cursor is not visible |
Calculates the height needed for a given number of lines
| Name | Type | Description |
|---|
numLines | number | The number of lines to calculate the height of |
Returns:
| Type | Description |
|---|
| number | The height needed to fit the amount of lines |
Flushes the text state
| Name | Type | Description |
|---|
textState | Object | The text state to flush |
Forcibly select an index
| Name | Type | Description |
|---|
index | number | The index to select |
Get the height of a gauge line
Returns:
| Type | Description |
|---|
| number | Amount of pixels tall for a gauge line |
Stops displaying the window
Hides additional sprites
Hides the background dimmer sprite
Hides the associated help window
Check which index is hit
Returns:
| Type | Description |
|---|
| number | The index that is hit |
Test if an index is hit at given x/y coordinates
| Name | Type | Description |
|---|
x | number | The x coordinate to check |
y | number | The y coordinate to check |
Returns:
| Type | Description |
|---|
| number | The index at the given coordinates |
Get the current index
Returns:
| Type | Description |
|---|
| number | The currently selected index |
Initializes the window
Check if cancel is enabled
Returns:
| Type | Description |
|---|
| boolean | True if cancel is enabled |
Check if cancel input is triggered
Returns:
| Type | Description |
|---|
| boolean | True if cancel input is triggered |
Checks whether the window is completely closed (openness == 0)
Returns:
| Type | Description |
|---|
| boolean | True if the window is closed |
Check if the window is closing
Returns:
| Type | Description |
|---|
| boolean | True if window is currently closing |
Check if the item at the currently selected index is enabled
Returns:
| Type | Description |
|---|
| boolean | True if the current item is enabled |
Check if the cursor can be moved
Returns:
| Type | Description |
|---|
| boolean | True if the cursor can be moved |
Check if there is a handler function for a symbol
| Name | Type | Description |
|---|
symbol | string | The id (or symbol) of the function |
Returns:
| Type | Description |
|---|
| boolean | True if a function exists for that symbol |
Check if there is only one row
Returns:
| Type | Description |
|---|
| boolean | True if only one row |
Determine if hovering is enabled
Returns:
| Type | Description |
|---|
| boolean | True if hovering is enabled |
Check if OK is enabled
Returns:
| Type | Description |
|---|
| boolean | True if OK is enabled |
Check if OK input is triggered
Returns:
| Type | Description |
|---|
| boolean | True if OK input is triggered |
Checks whether the window is completely open (openness == 255)
Returns:
| Type | Description |
|---|
| boolean | True if the window is open |
Check if the window is open and active
Returns:
| Type | Description |
|---|
| boolean | True if the window is both open and active (and visible) |
Check if the window is opening
Returns:
| Type | Description |
|---|
| boolean | True if window is currently opening |
Check if scrolling is enabled
Returns:
| Type | Description |
|---|
| boolean | True if scrolling is enabled |
Check if touch OK is enabled
Returns:
| Type | Description |
|---|
| boolean | True if touch OK is enabled |
Check if touch scrolling is enabled
Returns:
| Type | Description |
|---|
| boolean | True if the player can scroll the window using the touch controls |
Check if the last touch input was inside the window
Returns:
| Type | Description |
|---|
| boolean | True if touched inside the window |
Check if wheel scrolling is enabled
Returns:
| Type | Description |
|---|
| boolean | True if the player can scroll the window using the mouse wheel |
Gets the height of an item
Returns:
| Type | Description |
|---|
| number | Height of an item |
Gets the rectangle that covers the item at the given index, after applying x and y padding
| Name | Type | Description |
|---|
index | number | The index of the item |
Returns:
| Type | Description |
|---|
| Rectangle | The rectangle that covers the item |
Gets the padding for an item
Returns:
| Type | Description |
|---|
| number | Amount of item padding |
Gets the rectangle that covers the item at the given index
| Name | Type | Description |
|---|
index | number | The index of the item |
Returns:
| Type | Description |
|---|
| Rectangle | The rectangle that covers the item |
Gets the rectangle that covers the item at the given index, after applying x padding
| Name | Type | Description |
|---|
index | number | The index of the item |
Returns:
| Type | Description |
|---|
| Rectangle | The rectangle that covers the item |
Get the width of an item
Returns:
| Type | Description |
|---|
| number | Width of one item |
Gets the height in pixels of one line
Returns:
| Type | Description |
|---|
| number | Height of a line |
Loads face images for all actors in the party
Loads the windowskin for the window
Makes the font size bigger by 12
Makes the font size smaller by 12
Get the amount of columns
Returns:
| Type | Description |
|---|
| number | Amount of columns |
Gets the max font size in a line of text
| Name | Type | Description |
|---|
line | string | The line of text |
Returns:
| Type | Description |
|---|
| number | The largest font size seen in the line of text |
Gets the max amount of items in the window
Returns:
| Type | Description |
|---|
| number | Amount of items |
Gets the number of items in a page
Returns:
| Type | Description |
|---|
| number | The number of items in a page |
Gets the number of rows in a page
Returns:
| Type | Description |
|---|
| number | The number of rows in a page |
Get number of rows
Returns:
| Type | Description |
|---|
| number | Amount of rows |
Get the maximum scroll x position
Returns:
| Type | Description |
|---|
| number | The maximum scroll x position |
Get the maximum scroll y position
Returns:
| Type | Description |
|---|
| number | The maximum scroll y position |
Gets the max top row
Returns:
| Type | Description |
|---|
| number | The max top row |
Gets the number of visible items
Returns:
| Type | Description |
|---|
| number | The number of visible items |
Sets the x, y, width, and height of the window
| Name | Type | Description |
|---|
x | number | The new x coordinate of the window |
y | number | The new y coordinate of the window |
width | number | The new width of the window |
height | number | The new height of the window |
Moves the cursor position by the given amount
| Name | Type | Description |
|---|
x | number | The amount of horizontal movement |
y | number | The amount of vertical movement |
Moves the inner children by the given amount
| Name | Type | Description |
|---|
x | number | The amount of horizontal movement |
y | number | The amount of vertical movement |
Gets an escape code
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| string | The escape code, will be empty string if none |
obtainEscapeParam(textState)int | stringinherited
Gets an escape param
| Name | Type | Description |
|---|
textState | Object | The text state object |
Returns:
| Type | Description |
|---|
| int|string | The escape param, will be empty string if none |
Handling for touch cancel input
Handling for touch OK input
Handling for when touch scrolling starts
Handling for when touch scrolling ends
Handling for when scrolling starts
Handling for when touch is selected
| Name | Type | Description |
|---|
trigger | boolean | If triggered or just hovered |
Start opening the window
Get the total height
Returns:
| Type | Description |
|---|
| number | Total height |
Get the overall width of the window
Returns:
| Type | Description |
|---|
| number | The overall width of the window |
Clears and then draws the window content
Gets an actor name from their position in the party
| Name | Type | Description |
|---|
n | number | Position in the party |
Returns:
| Type | Description |
|---|
| string | The actor's name |
Places the actor name sprite
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to place the sprite |
y | number | The y coordinate to place the sprite |
Place the hp/mp/tp gauge sprites
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to place the sprite |
y | number | The y coordinate to place the sprite |
Places the gauge sprite
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
type | string | The gauge type (ex: hp/mp/tp) |
x | number | The x coordinate to place the sprite |
y | number | The y coordinate to place the sprite |
Places the state icon sprite
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to place the sprite |
y | number | The y coordinate to place the sprite |
Place the time gauge sprite (used for TPB battle system)
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
x | number | The x coordinate to place the sprite |
y | number | The y coordinate to place the sprite |
Plays the buzzer sound effect
Plays the cursor sound effect
Plays the ok sound effect
Processes all text within a text state object
| Name | Type | Description |
|---|
textState | Object | The text state to process |
Processing for cancel input
Processes a character in a text state at the current index of the text state
| Name | Type | Description |
|---|
textState | Object | The text state object for processing a character |
Processes a color change
| Name | Type | Description |
|---|
colorIndex | number | The index of the color to change to |
processControlCharacter(textState, c)inherited
Processes a control character within a text state
| Name | Type | Description |
|---|
textState | Object | The text state object with the character |
c | string | The character to process |
Processing for a cursor move
processDrawIcon(iconIndex, textState)inherited
Processes drawing an icon
| Name | Type | Description |
|---|
iconIndex | number | The index of the icon to draw |
textState | Object | The text state object |
processEscapeCharacter(code, textState)inherited
Processes an escape character in a text state
| Name | Type | Description |
|---|
code | string | The escape character's code |
textState | Object | The text state object |
Processing for handled methods
Processing for a new line
| Name | Type | Description |
|---|
textState | Object | The text state object |
Processing for ok input
Processing for pagedown
Processing for pageup
Processing for when touched
Processing for scrolling by touch
Processing for scrolling by mouse wheel
Redraws the currently selected item
Redraws the item at the given index
| Name | Type | Description |
|---|
index | number | The index of the item to redraw |
Refreshes the window
Refreshes the cursor
Refreshes the cursor for all
Refreshes the background dimmer sprite
Reselects the last index that was selected
Resets font settings to defaults
Resets text and outline color to defaults
Gets the current row
Returns:
| Type | Description |
|---|
| number | The current row |
Get the spacing between rows
Returns:
| Type | Description |
|---|
| number | Spacing between rows |
Get the base scroll X position
Returns:
| Type | Description |
|---|
| number | The base scroll X position |
Get the base scroll Y position
Returns:
| Type | Description |
|---|
| number | The base scroll Y position |
Get the height of one block for scrolling
Returns:
| Type | Description |
|---|
| number | The height of a scroll block |
Get the width of one block for scrolling
Returns:
| Type | Description |
|---|
| number | The width of a scroll block |
Add to the x and y scroll position
| Name | Type | Description |
|---|
x | number | The amount to add to the scroll x position |
y | number | The amount to add to the scroll y position |
Scroll to a set position
| Name | Type | Description |
|---|
x | number | The x position to scroll to |
y | number | The y position to scroll to |
Get the current scroll X position
Returns:
| Type | Description |
|---|
| number | The x position of the scroll |
Get the current scroll Y position
Returns:
| Type | Description |
|---|
| number | The y position of the scroll |
Selects the given index
| Name | Type | Description |
|---|
index | number | The index to select |
Sets the actor object for the window
| Name | Type | Description |
|---|
actor | Game_Actor | The Game Actor object |
Sets the background type of the window
| Name | Type | Description |
|---|
type | number | The type of background (0 = normal, 1 = dim, 2 = transparent) |
Set the cursor all flag
| Name | Type | Description |
|---|
cursorAll | boolean | The new cursor all setting |
Set the cursor fixed flag
| Name | Type | Description |
|---|
cursorFixed | boolean | The new cursor fixed setting |
Sets the position of the command cursor
| Name | Type | Description |
|---|
x | number | The x coordinate of the cursor |
y | number | The y coordinate of the cursor |
width | number | The width of the cursor |
height | number | The height of the cursor |
Sets a handler function
| Name | Type | Description |
|---|
symbol | string | The id (or symbol) of the function |
method | function | The method to call when the symbol is called |
Associates the given help window with this window
| Name | Type | Description |
|---|
helpWindow | Window_Help | The help window |
Sets the help window item
| Name | Type | Description |
|---|
item | * | The object to pass to the help window |
Sets the x and y scroll acceleration
| Name | Type | Description |
|---|
x | number | The x scroll acceleration |
y | number | The y scroll acceleration |
Changes the color of the background
| Name | Type | Description |
|---|
r | number | The red value in the range (-255, 255) |
g | number | The green value in the range (-255, 255) |
b | number | The blue value in the range (-255, 255) |
Sets the top row by scrolling to the row
| Name | Type | Description |
|---|
row | number | The row to scroll to |
Displays the window
Shows the background dimmer sprite
Shows the associated help window
Add to the x and y scroll position over an amount of time
| Name | Type | Description |
|---|
x | number | The amount to add to the scroll x position |
y | number | The amount to add to the scroll y position |
Smoothly scroll down
| Name | Type | Description |
|---|
n | number | The amount of items to scroll down |
Scroll to a set position over an amount of time
| Name | Type | Description |
|---|
x | number | The x position to scroll to |
y | number | The y position to scroll to |
Smoothly scroll up
| Name | Type | Description |
|---|
n | number | The amount of items to scroll up |
Smoothly selects an index
| Name | Type | Description |
|---|
index | number | The index to select |
Gets the system text color
Returns:
| Type | Description |
|---|
| string | The system text color |
Calculates the width needed for a given string of text. Does support text codes.
| Name | Type | Description |
|---|
text | string | The text to calculate the width for |
Returns:
| Type | Description |
|---|
| Object | The width and height of the text |
Calculates the width needed for a given string of text. Does not support text codes.
| Name | Type | Description |
|---|
text | string | The text to calculate the width for |
Returns:
| Type | Description |
|---|
| number | The width of the text |
Gets the top index
Returns:
| Type | Description |
|---|
| number | The top index |
Gets the top row
Returns:
| Type | Description |
|---|
| number | The top row |
Gets the opacity to use for a translucent effect
Returns:
| Type | Description |
|---|
| number | The opacity to use for a translucent effect |
Updates the window for each frame
Updates the arrow up/down visibility
Updates the window's background opacity
Updates the background dimmer sprite
Updates the closing effect
Updates the help window
Update input data
Updates the opening effect
Updates the window origin
Updates the window's padding
Updates the scroll acceleration
Updates the scroll base
| Name | Type | Description |
|---|
baseX | number | The new base x of the scroll |
baseY | number | The new base y of the scroll |
Updates smooth scrolling
Updates the window's tone
Updates the transform on all children of this container for rendering