Class: Window_Message

Window_Message

new Window_Message()

The window for displaying text messages.

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

contentsBackBitmapinherited

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

opacitynumberinherited

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

opennessnumberinheritedoverrides

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

pausebooleaninheritedoverrides

The visibility of the pause sign

upArrowVisiblebooleaninherited

The visibility of the up scroll arrow

widthnumberinherited

The width of the window in pixels

windowskinBitmapinherited

The image used as a window skin

Methods

addChildToBack(child)objectinherited

Adds a child between the background and contents
NameTypeDescription
childobjectThe child to add
Returns:
TypeDescription
objectThe child that was added

addInnerChild(child)objectinherited

Adds a child to the client area
NameTypeDescription
childobjectThe child to add
Returns:
TypeDescription
objectThe child that was added

areSettingsChanged()boolean

Check if the message window settings are changed
Returns:
TypeDescription
booleanTrue if message settings changed

canBreakHere(textState)boolean

Check if the message can break
NameTypeDescription
textStateObjectThe text state object
Returns:
TypeDescription
booleanTrue if message can break

canStart()boolean

Check if the window can start
Returns:
TypeDescription
booleanTrue if the window can start
Cancels waiting
Since:
  • 1.8.0

checkToNotClose()

Check if the window should instead stay open if it is closing
Clears window flags
Destroys the window

doesContinue()boolean

Check if the message continues
Returns:
TypeDescription
booleanTrue if message continues

drawMessageFace()

Draws the face in the message window
Draws the window shape into PIXI.Graphics object. Used by WindowLayer
Initializes window variables
Initializes the window

isAnySubWindowActive()boolean

Check if there is any sub window that is currently active
Returns:
TypeDescription
booleanTrue if choice/num input/event item window is active

isClosed()booleaninherited

Checks whether the window is completely closed (openness == 0)
Returns:
TypeDescription
booleanTrue if the window is closed

isEndOfText(textState)boolean

Check if there is no more text in the text state
NameTypeDescription
textStateObjectThe text state object
Returns:
TypeDescription
booleanTrue if no more text

isOpen()booleaninherited

Checks whether the window is completely open (openness == 255)
Returns:
TypeDescription
booleanTrue if the window is open

isTriggered()boolean

Check if input is triggered
Returns:
TypeDescription
booleanTrue if input is triggered

isWaiting()boolean

Check if the window is waiting
Since:
  • Version 1.2.1
Returns:
TypeDescription
booleanTrue if the window is waiting

loadMessageFace()

Loads the face image for the message window

move(x, y, width, height)inherited

Sets the x, y, width, and height of the window
NameTypeDescription
xnumberThe new x coordinate of the window
ynumberThe new y coordinate of the window
widthnumberThe new width of the window
heightnumberThe new height of the window

moveCursorBy(x, y)inherited

Moves the cursor position by the given amount
NameTypeDescription
xnumberThe amount of horizontal movement
ynumberThe amount of vertical movement

moveInnerChildrenBy(x, y)inherited

Moves the inner children by the given amount
NameTypeDescription
xnumberThe amount of horizontal movement
ynumberThe amount of vertical movement

needsNewPage(textState)boolean

Check if the message needs a new page
NameTypeDescription
textStateObjectThe text state object
Returns:
TypeDescription
booleanTrue if a new page is needed

newLineX(textState)number

Get the x coordinate for a new line
NameTypeDescription
textStateObjectThe text state object
Returns:
TypeDescription
numberThe x coordinate of a new line

newPage(textState)

Starts a new page
NameTypeDescription
textStateObjectThe text state object
Handling for when there is no more text

processNewPage(textState)

Processes a new page
NameTypeDescription
textStateObjectThe text state object

setChoiceListWindow(nameBoxWindow)

Associates the choice list window
NameTypeDescription
nameBoxWindowWindow_ChoiceListThe choice list window to associate with this window

setCursorRect(x, y, width, height)inherited

Sets the position of the command cursor
NameTypeDescription
xnumberThe x coordinate of the cursor
ynumberThe y coordinate of the cursor
widthnumberThe width of the cursor
heightnumberThe height of the cursor

setEventItemWindow(nameBoxWindow)

Associates the event item window
NameTypeDescription
nameBoxWindowWindow_EventItemThe event item window to associate with this window

setGoldWindow(goldWindow)

Associates the gold window
NameTypeDescription
goldWindowWindow_GoldThe gold window to associate with this window

setNameBoxWindow(nameBoxWindow)

Associates the name box window
NameTypeDescription
nameBoxWindowWindow_NameBoxThe name box window to associate with this window

setNumberInputWindow(nameBoxWindow)

Associates the number input window
NameTypeDescription
nameBoxWindowWindow_NumberInputThe number input window to associate with this window

setTone(r, g, b)inherited

Changes the color of the background
NameTypeDescription
rnumberThe red value in the range (-255, 255)
gnumberThe green value in the range (-255, 255)
bnumberThe blue value in the range (-255, 255)

shouldBreakHere(textState)boolean

Check if the message should break
NameTypeDescription
textStateObjectThe text state object
Returns:
TypeDescription
booleanTrue if message should break

startInput()boolean

Starts input
Returns:
TypeDescription
booleanTrue if input started

startMessage()

Starts the message
Starts a pause

startWait(count)

Starts a wait for the given count
NameTypeDescription
countnumberThe amount to wait for

synchronizeNameBox()

Sync the name box window with this window

terminateMessage()

Ends the message
Updates the window for each frame

updateBackground()

Updates the window background

updateInput()boolean

Update window input
Returns:
TypeDescription
booleanTrue if updated

updateLoading()boolean

Update window loading
Returns:
TypeDescription
booleanTrue if updated

updateMessage()boolean

Updates the message
Returns:
TypeDescription
booleanTrue if updated

updatePlacement()

Update window placements

updateShowFast()

Update for showing fast

updateSpeakerName()

Updates the speaker name for the name box window

updateTransform()inherited

Updates the transform on all children of this container for rendering

updateWait()boolean

Updates the window wait
Returns:
TypeDescription
booleanTrue if updated