Extends

• Window

Members

activebooleaninheritedoverrides

The active state for the window

backOpacitynumberinheritedoverrides

The opacity of the window background (0 to 255)

contentsBitmapinheritedoverrides

The bitmap used for the window contents

contentsBackBitmapinheritedoverrides

The bitmap used for the window contents background

contentsOpacitynumberinherited

The opacity of the window contents (0 to 255)

cursorVisiblebooleaninherited

The visibility of the cursor

downArrowVisiblebooleaninherited

The visibility of the down scroll arrow

frameVisiblebooleaninherited

The visibility of the frame

heightnumberinherited

The height of the window in pixels

innerHeightnumberreadonlyinherited

The height of the content area in pixels

innerRectRectanglereadonlyinherited

The rectangle of the content area

innerWidthnumberreadonlyinherited

The width of the content area in pixels

marginnumberinherited

The size of the margin for the window background

opacitynumberinheritedoverrides

The opacity of the window without contents (0 to 255)

opennessnumberinheritedoverrides

The openness of the window (0 to 255)

originPointinherited

The origin point of the window for scrolling

paddingnumberinheritedoverrides

The size of the padding between the frame and contents

pausebooleaninherited

The visibility of the pause sign

upArrowVisiblebooleaninherited

The visibility of the up scroll arrow

widthnumberinherited

The width of the window in pixels

windowskinBitmapinheritedoverrides

The image used as a window skin

Methods

activate()

Window_Base.js:286

Activates the window

actorName(n)string

Window_Base.js:516

Gets an actor name from their id

Name	Type	Description
n	number	Actor id

Returns:

Type	Description
string	The actor's name

addChildToBack(child)objectinherited

Window.js:452

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

addInnerChild(child)objectinherited

Window.js:463

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

baseTextRect()Rectangle

Window_Base.js:95

Creates a rectangle for an item of text

Returns:

Type	Description
Rectangle	Rectangle that encompasses the text item

calcTextHeight(textState)string

Window_Base.js:690

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

changeOutlineColor(color)

Window_Base.js:329

Changes the text outline color of text drawn to the window

Name	Type	Description
color	string	The new outline color to use

changePaintOpacity(enabled)

Window_Base.js:338

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

changeTextColor(color)

Window_Base.js:320

Changes the text color of text drawn to the window

Name	Type	Description
color	string	The new color to draw text in

checkRectObject(rect)boolean

Window_Base.js:47

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

close()

Window_Base.js:244

Start closing the window

contentsHeight()number

Window_Base.js:178

Gets the height needed for the window contents

Returns:

Type	Description
number	Height needed for the window contents

contentsWidth()number

Window_Base.js:169

Gets the width needed for the window contents

Returns:

Type	Description
number	Width needed for the window contents

convertEscapeCharacters(text)string

Window_Base.js:491

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

createContents()

Window_Base.js:143

Creates the contents of the window

createDimmerSprite()

Window_Base.js:867

Creates the background dimmer sprite

createTextBuffer(rtl)string

Window_Base.js:480

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

Window_Base.js:419

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

deactivate()

Window_Base.js:293

Deactivates the window

destroy()inheritedoverrides

Window.js:332

Destroys the window

destroyContents()

Window_Base.js:155

Destroys the contents of the window

drawCharacter(characterName, characterIndex, x, y)

Window_Base.js:781

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)

Window_Base.js:823

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)

Window_Base.js:755

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

drawIcon(iconIndex, x, y)

Window_Base.js:735

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

drawItemName(item, x, y, width)

Window_Base.js:802

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

drawRect(x, y, width, height)

Window_Base.js:350

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

drawShape()inherited

Window.js:486

Draws the window shape into PIXI.Graphics object. Used by WindowLayer

drawText(text, x, y, maxWidth, align)

Window_Base.js:366

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

drawTextEx(text, x, y, width)number

Window_Base.js:389

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

fittingHeight(numLines)number

Window_Base.js:128

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

flushTextState(textState)

Window_Base.js:455

Flushes the text state

Name	Type	Description
textState	Object	The text state to flush

hide()

Window_Base.js:279

Stops displaying the window

hideBackgroundDimmer()

Window_Base.js:877

Hides the background dimmer sprite

initialize()inheritedoverrides

Window.js:17

Initializes the window

isClosed()booleaninherited

Window.js:383

Checks whether the window is completely closed (openness == 0)

Returns:

Type	Description
boolean	True if the window is closed

isClosing()boolean

Window_Base.js:265

Check if the window is closing

Returns:

Type	Description
boolean	True if window is currently closing

isOpen()booleaninherited

Window.js:374

Checks whether the window is completely open (openness == 255)

Returns:

Type	Description
boolean	True if the window is open

isOpening()boolean

Window_Base.js:256

Check if the window is opening

Returns:

Type	Description
boolean	True if window is currently opening

itemHeight()number

Window_Base.js:77

Gets the height in pixels of an item

Returns:

Type	Description
number	Height of an item

itemPadding()number

Window_Base.js:86

Gets the padding for an item

Returns:

Type	Description
number	Amount of item padding

itemWidth()number

Window_Base.js:68

Gets the width in pixels of an item

Returns:

Type	Description
number	Width of an item

lineHeight()number

Window_Base.js:59

Gets the height in pixels of one line

Returns:

Type	Description
number	Height of a line

loadWindowskin()

Window_Base.js:104

Loads the windowskin for the window

makeFontBigger()

Window_Base.js:669

Makes the font size bigger by 12

makeFontSmaller()

Window_Base.js:678

Makes the font size smaller by 12

maxFontSizeInLine(line)number

Window_Base.js:705

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

move(x, y, width, height)inherited

Window.js:359

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

moveCursorBy(x, y)inherited

Window.js:413

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

moveInnerChildrenBy(x, y)inherited

Window.js:424

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

obtainEscapeCode(textState)string

Window_Base.js:580

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 | string

Window_Base.js:597

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

open()

Window_Base.js:234

Start opening the window

partyMemberName(n)string

Window_Base.js:527

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

playBuzzerSound()

Window_Base.js:928

Plays the buzzer sound effect

playCursorSound()

Window_Base.js:914

Plays the cursor sound effect

playOkSound()

Window_Base.js:921

Plays the ok sound effect

processAllText(textState)

Window_Base.js:443

Processes all text within a text state object

Name	Type	Description
textState	Object	The text state to process

processCharacter(textState)

Window_Base.js:537

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

processColorChange(colorIndex)

Window_Base.js:645

Processes a color change

Name	Type	Description
colorIndex	number	The index of the color to change to

processControlCharacter(textState, c)

Window_Base.js:553

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

processDrawIcon(iconIndex, textState)

Window_Base.js:655

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)

Window_Base.js:614

Processes an escape character in a text state

Name	Type	Description
code	string	The escape character's code
textState	Object	The text state object

processNewLine(textState)

Window_Base.js:568

Processing for a new line

Name	Type	Description
textState	Object	The text state object

refreshDimmerBitmap()

Window_Base.js:895

Refreshes the background dimmer sprite

resetFontSettings()

Window_Base.js:185

Resets font settings to defaults

resetTextColor()

Window_Base.js:194

Resets text and outline color to defaults

setBackgroundType(type)

Window_Base.js:836

Sets the background type of the window

Name	Type	Description
type	number	The type of background (0 = normal, 1 = dim, 2 = transparent)

setCursorRect(x, y, width, height)inherited

Window.js:395

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

setTone(r, g, b)inherited

Window.js:438

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)

show()

Window_Base.js:272

Displays the window

showBackgroundDimmer()

Window_Base.js:852

Shows the background dimmer sprite

systemColor()string

Window_Base.js:302

Gets the system text color

Returns:

Type	Description
string	The system text color

textSizeEx(text)Object

Window_Base.js:402

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

textWidth(text)number

Window_Base.js:376

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

translucentOpacity()number

Window_Base.js:311

Gets the opacity to use for a translucent effect

Returns:

Type	Description
number	The opacity to use for a translucent effect

update()inheritedoverrides

Window.js:340

Updates the window for each frame

updateBackOpacity()

Window_Base.js:118

Updates the window's background opacity

updateBackgroundDimmer()

Window_Base.js:886

Updates the background dimmer sprite

updateClose()

Window_Base.js:222

Updates the closing effect

updateOpen()

Window_Base.js:210

Updates the opening effect

updatePadding()

Window_Base.js:111

Updates the window's padding

updateTone()

Window_Base.js:135

Updates the window's tone

updateTransform()inherited

Window.js:471

Updates the transform on all children of this container for rendering