The window for displaying battle progress. No frame is displayed, but it is handled as a window for convenience.
Extends
Members
activebooleaninherited
- The active state for the window
backOpacitynumberinherited
- The opacity of the window background (0 to 255)
- The bitmap used for the window contents
- 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
- 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
- The opacity of the window without contents (0 to 255)
opennessnumberinherited
- The openness of the window (0 to 255)
- The origin point of the window for scrolling
paddingnumberinherited
- 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
- The image used as a window skin
Methods
activate()inherited
- Activates the window
actorName(n)stringinherited
- Gets an actor name from their id
Name Type Description nnumber Actor id Returns:
Type Description string The actor's name addChildToBack(child)objectinherited
- Adds a child between the background and contents
Name Type Description childobject The child to add Returns:
Type Description object The child that was added addInnerChild(child)objectinherited
- Adds a child to the client area
Name Type Description childobject The child to add Returns:
Type Description object The child that was added - Adds a new line of text to the window
Name Type Description textstring The text to add - Gets the background color
Returns:
Type Description string The background color - Gets the background opacity
Returns:
Type Description number The opacity of the background backRect()Rectangle
- Gets the window background rectangle
Returns:
Type Description Rectangle The Rectangle that contains the window background - Creates a rectangle for an item of text
Returns:
Type Description Rectangle Rectangle that encompasses the text item calcTextHeight(textState)stringinherited
- Calculates the height of the text in a text state
Name Type Description textStateObject The text state object Returns:
Type Description string The height of the text - Calls the next method queued up in the window
Throws:
Error if the method has no name or is not a valid method changeOutlineColor(color)inherited
- Changes the text outline color of text drawn to the window
Name Type Description colorstring The new outline color to use changePaintOpacity(enabled)inherited
- Changes the opacity of what is painted to the contents of the window
Name Type Description enabledboolean True = use full opacity | False = use translucent opacity changeTextColor(color)inherited
- Changes the text color of text drawn to the window
Name Type Description colorstring The new color to draw text in checkRectObject(rect)booleaninherited
- 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 rectangleReturns:
Type Description boolean True if the object is a valid rectangle - Clears the lines and base line stack
close()inherited
- Start closing the window
contentsHeight()numberinherited
- Gets the height needed for the window contents
Returns:
Type Description number Height needed for the window contents contentsWidth()numberinherited
- Gets the width needed for the window contents
Returns:
Type Description number Width needed for the window contents convertEscapeCharacters(text)stringinherited
- Converts escape code characters in text, for example \v[x]
Name Type Description textstring The text to convert Returns:
Type Description string Text with escape characters converted createContents()inherited
- Creates the contents of the window
createDimmerSprite()inherited
- Creates the background dimmer sprite
createTextBuffer(rtl)stringinherited
- Creates a text buffer
Name Type Description rtlboolean 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 textstring The text to draw xnumber The x coordinate to draw the text ynumber The y coordinate to draw the text widthnumber The width of the text Returns:
Type Description Object The text state object deactivate()inherited
- Deactivates the window
destroy()inherited
- Destroys the window
destroyContents()inherited
- Destroys the contents of the window
- Handling for the display of an action
Name Type Description subjectGame_Battler The subject of the action itemObject The item of an action (skill or item) - Displays action results
Name Type Description subjectGame_Battler The subject targetGame_Battler The target - Displays added states
Name Type Description targetGame_Battler The target - Displays states or buffs
Name Type Description targetGame_Battler The target - Displays auto affected status
Name Type Description targetGame_Battler The target - Displays buffs
Name Type Description targetGame_Battler The target buffsArray.<number> Array of paramIds that are buffed fmtstring The message format - Displays changed buffs
Name Type Description targetGame_Battler The target - Displays a change in state
Name Type Description targetGame_Battler The target - Displays a counter
Name Type Description targetGame_Battler The target - Displays a critical
Name Type Description targetGame_Battler The target - Handling for displaying the current state of a subject
Name Type Description subjectGame_Battler The subject - Displays damage
Name Type Description targetGame_Battler The target - Displays an evade
Name Type Description targetGame_Battler The target - Displays action failure
Name Type Description targetGame_Battler The target - Displays hp damage
Name Type Description targetGame_Battler The target - Displays an item message
Name Type Description fmtstring The format of the message subjectGame_Battler The subject itemObject The item - Displays a miss
Name Type Description targetGame_Battler The target - Displays mp damage
Name Type Description targetGame_Battler The target - Displays a reflection
Name Type Description targetGame_Battler The target - Handling for displaying regeneration of a subject
Name Type Description subjectGame_Battler The subject - Displays removed states
Name Type Description targetGame_Battler The target - Displays a substitute
Name Type Description substituteGame_Battler The substitute targetGame_Battler The original target - Displays tp damage
Name Type Description targetGame_Battler The target - Draws the window background
drawCharacter(characterName, characterIndex, x, y)inherited
- Draws a character at x/y coordinates
Name Type Description characterNamestring The name of the character sheet bitmap characterIndexnumber The index of the character on the sheet xnumber The x coordinate ynumber The y coordinate drawCurrencyValue(value, unit, x, y, width)inherited
- Draws a currency value
Name Type Description valuenumber The amount of currency unitstring The currency unit xnumber The x coordinate ynumber The y coordinate widthnumber 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 faceNamestring The name of the face sheet bitmap faceIndexnumber The index of the face on the sheet xnumber The x coordinate ynumber The y coordinate widthnumber The width of the face heightnumber The height of the face drawIcon(iconIndex, x, y)inherited
- Draws an icon at x/y coordinates
Name Type Description iconIndexnumber The index of the icon to draw xnumber The x coordinate ynumber The y coordinate drawItemName(item, x, y, width)inherited
- Draws an item's name with its icon
Name Type Description itemObject The item object to draw, must at least have iconIndex and name properties xnumber The x coordinate ynumber The y coordinate widthnumber The width available to draw the item name - Draws a line's text at a given line index
Name Type Description indexnumber The line index to draw drawRect(x, y, width, height)inherited
- Draws a rectangle of given width/height at given x/y coordinates
Name Type Description xnumber The X coordinate of the upper left corner of the rectangle ynumber The Y coordinate of the upper left corner of the rectangle widthnumber The width in pixels of the rectangle heightnumber The height in pixels of the rectangle drawShape()inherited
- 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 textstring The text to draw xnumber The x coordinate to begin drawing the text ynumber The y coordinate to begin drawing the text maxWidthnumber The maximum width in pixels of the text alignstring The alignment of the text drawTextEx(text, x, y, width)numberinherited
- Draws text to the window's contents. Does support text codes.
Name Type Description textstring The text to draw xnumber The x coordinate to draw the text ynumber The y coordinate to draw the text widthnumber The width of the text Returns:
Type Description number The width of the drawn text - Handling for the end of an action
Name Type Description subjectGame_Battler The subject of the action fittingHeight(numLines)numberinherited
- Calculates the height needed for a given number of lines
Name Type Description numLinesnumber The number of lines to calculate the height of Returns:
Type Description number The height needed to fit the amount of lines flushTextState(textState)inherited
- Flushes the text state
Name Type Description textStateObject The text state to flush - Stops displaying the window
hideBackgroundDimmer()inherited
- Hides the background dimmer sprite
- Initializes the window
- Check if the window is busy
Returns:
Type Description boolean True if the window is busy isClosed()booleaninherited
- Checks whether the window is completely closed (openness == 0)
Returns:
Type Description boolean True if the window is closed isClosing()booleaninherited
- Check if the window is closing
Returns:
Type Description boolean True if window is currently closing - Check if the window should be fast forwarding
Returns:
Type Description boolean True if the window is fast forwarding isOpen()booleaninherited
- Checks whether the window is completely open (openness == 255)
Returns:
Type Description boolean True if the window is open isOpening()booleaninherited
- Check if the window is opening
Returns:
Type Description boolean True if window is currently opening itemHeight()numberinherited
- Gets the height in pixels of an item
Returns:
Type Description number Height of an item itemPadding()numberinherited
- Gets the padding for an item
Returns:
Type Description number Amount of item padding itemWidth()numberinherited
- Gets the width in pixels of an item
Returns:
Type Description number Width of an item lineHeight()numberinherited
- Gets the height in pixels of one line
Returns:
Type Description number Height of a line lineRect(index)Rectangle
- Gets a rectangle object for a given line
Name Type Description indexnumber The line index Returns:
Type Description Rectangle The Rectangle that contains the line loadWindowskin()inherited
- Loads the windowskin for the window
makeFontBigger()inherited
- Makes the font size bigger by 12
makeFontSmaller()inherited
- Makes the font size smaller by 12
- Gets the hp damage text to show
Name Type Description targetGame_Battler The target Returns:
Type Description string HP damage text to show - Gets the mp damage text to show
Name Type Description targetGame_Battler The target Returns:
Type Description string MP damage text to show - Gets the tp damage text to show
Name Type Description targetGame_Battler The target Returns:
Type Description string TP damage text to show maxFontSizeInLine(line)numberinherited
- Gets the max font size in a line of text
Name Type Description linestring The line of text Returns:
Type Description number The largest font size seen in the line of text - Get the max lines the window should handle
Returns:
Type Description number Max number of lines - Get the message speed in the window
Returns:
Type Description number The message speed move(x, y, width, height)inherited
- Sets the x, y, width, and height of the window
Name Type Description xnumber The new x coordinate of the window ynumber The new y coordinate of the window widthnumber The new width of the window heightnumber The new height of the window moveCursorBy(x, y)inherited
- Moves the cursor position by the given amount
Name Type Description xnumber The amount of horizontal movement ynumber The amount of vertical movement moveInnerChildrenBy(x, y)inherited
- Moves the inner children by the given amount
Name Type Description xnumber The amount of horizontal movement ynumber The amount of vertical movement - Get the current number of lines in the window
Returns:
Type Description number The number of lines in the window obtainEscapeCode(textState)stringinherited
- Gets an escape code
Name Type Description textStateObject 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 textStateObject The text state object Returns:
Type Description int|string The escape param, will be empty string if none - Start opening the window
partyMemberName(n)stringinherited
- Gets an actor name from their position in the party
Name Type Description nnumber Position in the party Returns:
Type Description string The actor's name - Performs an action
Name Type Description subjectGame_Battler The subject of the action actionGame_Action The action to perform - Ends an action
Name Type Description subjectGame_Battler The subject of the action - Starts an action
Name Type Description subjectGame_Battler The subject of the action actionGame_Action The action to start - Performs a collapse
Name Type Description targetGame_Battler The target that collapsed - Performs a counter
Name Type Description targetGame_Battler The target that countered - Performs damage
Name Type Description targetGame_Battler The target that took damage - Performs an evade
Name Type Description targetGame_Battler The target that evaded - Performs a magic evade
Name Type Description targetGame_Battler The target that magic evaded - Performs a miss
Name Type Description targetGame_Battler The target of the miss - Performs recovery
Name Type Description targetGame_Battler The target that recovered - Performs a reflection
Name Type Description targetGame_Battler The target that reflected - Performs a substitute
Name Type Description substituteGame_Battler The substitute targetGame_Battler The original target playBuzzerSound()inherited
- Plays the buzzer sound effect
playCursorSound()inherited
- Plays the cursor sound effect
playOkSound()inherited
- Plays the ok sound effect
- Pops the base line and any lines afterwards
- Pops up damage on a target
Name Type Description targetGame_Battler The target where the damage popup should display processAllText(textState)inherited
- Processes all text within a text state object
Name Type Description textStateObject The text state to process processCharacter(textState)inherited
- Processes a character in a text state at the current index of the text state
Name Type Description textStateObject The text state object for processing a character processColorChange(colorIndex)inherited
- Processes a color change
Name Type Description colorIndexnumber The index of the color to change to processControlCharacter(textState, c)inherited
- Processes a control character within a text state
Name Type Description textStateObject The text state object with the character cstring The character to process processDrawIcon(iconIndex, textState)inherited
- Processes drawing an icon
Name Type Description iconIndexnumber The index of the icon to draw textStateObject The text state object processEscapeCharacter(code, textState)inherited
- Processes an escape character in a text state
Name Type Description codestring The escape character's code textStateObject The text state object processNewLine(textState)inherited
- Processing for a new line
Name Type Description textStateObject The text state object - Pushes a method onto the method stack with arguments
Name Type Description methodNamestring The method name to push - Pushes the base line to the stack
- Refreshes the window
refreshDimmerBitmap()inherited
- Refreshes the background dimmer sprite
resetFontSettings()inherited
- Resets font settings to defaults
resetTextColor()inherited
- Resets text and outline color to defaults
setBackgroundType(type)inherited
- Sets the background type of the window
Name Type Description typenumber The type of background (0 = normal, 1 = dim, 2 = transparent) setCursorRect(x, y, width, height)inherited
- Sets the position of the command cursor
Name Type Description xnumber The x coordinate of the cursor ynumber The y coordinate of the cursor widthnumber The width of the cursor heightnumber The height of the cursor - Associates the window with the spriteset
Name Type Description spritesetSpriteset_Battle The spriteset for the battle setTone(r, g, b)inherited
- Changes the color of the background
Name Type Description rnumber The red value in the range (-255, 255) gnumber The green value in the range (-255, 255) bnumber The blue value in the range (-255, 255) - Sets the wait mode of the window. For example, "movement" if there is anyone moving on the spriteset
Name Type Description waitModestring The mode of the window's wait - Displays the window
- Shows an actor attack animation
Name Type Description subjectGame_Battler The subject of the animation targetsArray.<Game_Battler> The target(s) of the animation - Shows an animation
Name Type Description subjectGame_Battler The subject of the animation targetsArray.<Game_Battler> The target(s) of the animation animationIdnumber The ID of the animation to show - Shows a normal attack animation
Name Type Description subjectGame_Battler The subject of the animation targetsArray.<Game_Battler> The target(s) of the animation showBackgroundDimmer()inherited
- Shows the background dimmer sprite
- Shows an enemy attack animation
- Shows a normal animation
Name Type Description targetsArray.<Game_Battler> The target(s) of the animation animationIdnumber The ID of the animation to show mirrorboolean If the animation should mirror - Handling for the start of an action
Name Type Description subjectGame_Battler The subject of the action actionGame_Action The action targetsArray.<Game_Battler> The target(s) of the action - Handling for battle turn start
systemColor()stringinherited
- Gets the system text color
Returns:
Type Description string The system text color textSizeEx(text)Objectinherited
- Calculates the width needed for a given string of text. Does support text codes.
Name Type Description textstring The text to calculate the width for Returns:
Type Description Object The width and height of the text textWidth(text)numberinherited
- Calculates the width needed for a given string of text. Does not support text codes.
Name Type Description textstring The text to calculate the width for Returns:
Type Description number The width of the text translucentOpacity()numberinherited
- Gets the opacity to use for a translucent effect
Returns:
Type Description number The opacity to use for a translucent effect update()overrides
- Updates the window
updateBackOpacity()inherited
- Updates the window's background opacity
updateBackgroundDimmer()inherited
- Updates the background dimmer sprite
updateClose()inherited
- Updates the closing effect
updateOpen()inherited
- Updates the opening effect
updatePadding()inherited
- Updates the window's padding
updateTone()inherited
- Updates the window's tone
updateTransform()inherited
- Updates the transform on all children of this container for rendering
- Updates the wait of the window
Returns:
Type Description boolean True if updated - Updates the wait count
Returns:
Type Description boolean True if updated - Updates the wait mode
Returns:
Type Description boolean True if the window is waiting - Starts the waiting process
- Sets the wait mode for an effect wait
- Sets the wait mode for a movement wait
- Waits for a new line