Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Window_Message


Window_Message

The window for displaying text messages.

class

Window_Message

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _background

_background: number

Protected _choiceWindow

_choiceWindow: Window_ChoiceList

Protected _closing

_closing: boolean

The closing property; determines if the window is closing.

type

{boolean}

memberof

Window_Base

Protected _faceBitmap

_faceBitmap: Bitmap

Protected _goldWindow

_goldWindow: Window_Gold

Protected _itemWindow

_itemWindow: Window_EventItem

Protected _lineShowFast

_lineShowFast: boolean

Protected _numberWindow

_numberWindow: Window_NumberInput

Protected _opening

_opening: boolean

The opening property; determines if the window is opening.

type

{boolean}

memberof

Window_Base

Protected _pauseSkip

_pauseSkip: boolean

Protected _positionType

_positionType: number

Protected _showFast

_showFast: boolean

Protected _textState

_textState: TextState

Protected _waitCount

_waitCount: number

Static Protected _faceHeight

_faceHeight: number

The standard face height; default is 144.

static
type

{number}

memberof

Window_Base

Static Protected _faceWidth

_faceWidth: number

The standard face width; default is 144.

static
type

{number}

memberof

Window_Base

Static Protected _iconHeight

_iconHeight: number

The standard icon height; default is 32.

static
type

{number}

memberof

Window_Base

Static Protected _iconWidth

_iconWidth: number

The standard icon width; default is 32.

static
type

{number}

memberof

Window_Base

Methods

activate

  • activate(): void

actorName

  • actorName(actorIndex: number): string

areSettingsChanged

  • areSettingsChanged(): boolean

calcTextHeight

  • calcTextHeight(textState: any, all: boolean): number
  • Calculates the text height of the textState (when using drawTextEx); if all is set to true, all lines of text are calculated, otherwise only a single line is processed.

    memberof

    Window_Base

    Parameters

    • textState: any
    • all: boolean

    Returns number

canStart

  • canStart(): boolean

canvasToLocalX

  • canvasToLocalX(x: number): number

canvasToLocalY

  • canvasToLocalY(y: number): number

changePaintOpacity

  • changePaintOpacity(enabled: boolean): void

changeTextColor

  • changeTextColor(color: string): void

checkToNotClose

  • checkToNotClose(): void

clearFlags

  • clearFlags(): void

close

  • close(): void

contentsHeight

  • contentsHeight(): number

contentsWidth

  • contentsWidth(): number

convertEscapeCharacters

  • convertEscapeCharacters(text: string): string

createContents

  • createContents(): void

createSubWindows

  • createSubWindows(): void

crisisColor

  • crisisColor(): string

deactivate

  • deactivate(): void

deathColor

  • deathColor(): string

dimColor1

  • dimColor1(): string

dimColor2

  • dimColor2(): string

doesContinue

  • doesContinue(): boolean

drawActorCharacter

  • drawActorCharacter(actor: Game_Actor, x: number, y: number): void

drawActorClass

  • drawActorClass(actor: Game_Actor, x: number, y: number, width: number): void

drawActorFace

  • drawActorFace(actor: Game_Actor, x: number, y: number, width: number, height: number): void

drawActorHp

  • drawActorHp(actor: Game_Actor, x: number, y: number, width: number): void

drawActorIcons

  • drawActorIcons(actor: Game_Actor, x: number, y: number, width: number): void

drawActorLevel

  • drawActorLevel(actor: Game_Actor, x: number, y: number): any

drawActorMp

  • drawActorMp(actor: Game_Actor, x: number, y: number, width: number): void

drawActorName

  • drawActorName(actor: Game_Actor, x: number, y: number, width: number): void

drawActorNickname

  • drawActorNickname(actor: Game_Actor, x: number, y: number, width: number): void

drawActorSimpleStatus

  • drawActorSimpleStatus(actor: Game_Actor, x: number, y: number, width: number): void

drawActorTp

  • drawActorTp(actor: Game_Actor, x: number, y: number, width: number): void

drawCharacter

  • drawCharacter(characterName: string, characterIndex: number, x: number, y: number): void
  • Draws a character (map sprites) at the specified x and y coordinate. CharacterName refers to character spritesheet, and characterIndex refers to the characterIndex on the spritesheet.

    memberof

    Window_Base

    Parameters

    • characterName: string
    • characterIndex: number
    • x: number
    • y: number

    Returns void

drawCurrencyValue

  • drawCurrencyValue(value: number, unit: string, x: number, y: number, width: number): void
  • Draws the currency value given at the specified x and y coordinates within the width given. Useful if you want to write your own custom currency value.

    memberof

    Window_Base

    Parameters

    • value: number
    • unit: string
    • x: number
    • y: number
    • width: number

    Returns void

drawCurrentAndMax

  • drawCurrentAndMax(current: number, max: number, x: number, y: number, width: number, color1: string, color2: string): void
  • Draws the current and max number at the specified x and y coordinate within the given width. Color1 represents the current number and color2 represents the max number when the text is drawn.

    memberof

    Window_Base

    Parameters

    • current: number
    • max: number
    • x: number
    • y: number
    • width: number
    • color1: string
    • color2: string

    Returns void

drawFace

  • drawFace(faceName: string, faceIndex: number, x: number, y: number, width: number, height: number): void

drawGauge

  • drawGauge(x: number, y: number, width: number, rate: number, color1: string, color2: string): any
  • Draws a gauge at the specified x and y coordinates within the given width. Color1 and Color2 represent the gradient as css color strings of the gauge.

    memberof

    Window_Base

    Parameters

    • x: number
    • y: number
    • width: number
    • rate: number
    • color1: string
    • color2: string

    Returns any

drawIcon

  • drawIcon(iconIndex: number, x: number, y: number): void
  • Draws an icon given the specified iconIndex at the specified x and y coordinates. The Width and Height of the icon is based on the _iconWidth and _iconHeight properties.

    memberof

    Window_Base

    Parameters

    • iconIndex: number
    • x: number
    • y: number

    Returns void

drawItemName

  • drawItemName(item: BaseItem, x: number, y: number, width: number): void

drawMessageFace

  • drawMessageFace(): void

drawText

  • drawText(text: string | number, x: number, y: number, maxWidth: number, align: string): void
  • Given text or a number, draws the content to the window's contents layer at the specified x and y coordinate within the max width. The text content can also be aligned with the align property. The possible alignments are: "left", "center", "right".

    memberof

    Window_Base

    Parameters

    • text: string | number
    • x: number
    • y: number
    • maxWidth: number
    • align: string

    Returns void

drawTextEx

  • drawTextEx(text: string, x: number, y: number): number

fittingHeight

  • fittingHeight(numLines: number): number
  • Returns the fitting height given a number of lines based on the line height plus standard padding of the window. Default formula: numLines lineHeight + standardPadding 2

    memberof

    Window_Base

    Parameters

    • numLines: number

    Returns number

gaugeBackColor

  • gaugeBackColor(): string

hide

  • hide(): void

hideBackgroundDimmer

  • hideBackgroundDimmer(): void

hpColor

hpGaugeColor1

  • hpGaugeColor1(): string

hpGaugeColor2

  • hpGaugeColor2(): string

initMembers

  • initMembers(): void

isAnySubWindowActive

  • isAnySubWindowActive(): boolean

isClosing

  • isClosing(): boolean

isEndOfText

isOpening

  • isOpening(): boolean

isTriggered

  • isTriggered(): boolean

lineHeight

  • lineHeight(): number

loadMessageFace

  • loadMessageFace(): void

loadWindowSkin

  • loadWindowSkin(): void

makeFontBigger

  • makeFontBigger(): void

makeFontSmaller

  • makeFontSmaller(): void

mpColor

mpCostColor

  • mpCostColor(): string

mpGaugeColor1

  • mpGaugeColor1(): string

mpGaugeColor2

  • mpGaugeColor2(): string

needsNewPage

  • needsNewPage(textState: TextState): boolean

newLineX

  • newLineX(): number

newPage

normalColor

  • normalColor(): string

numVisibleRows

  • numVisibleRows(): number

obtainEscapeCode

  • obtainEscapeCode(textState: TextState): string

obtainEscapeParam

  • obtainEscapeParam(textState: TextState): number | string

onEndOfText

  • onEndOfText(): void

open

  • open(): void

paramchangeTextColor

  • paramchangeTextColor(change: number): void
  • Changes the text color based on the powerUpColor, powerDownColor and normal color. powerUpColor is any number greater than 0, powerDownColor is any color less than 0, otherwise normal color is returned.

    memberof

    Window_Base

    Parameters

    • change: number

    Returns void

partyMemberName

  • partyMemberName(partyMemberIndex: number): string

pendingColor

  • pendingColor(): string

powerDownColor

  • powerDownColor(): string

powerUpColor

  • powerUpColor(): string

processCharacter

  • processCharacter(textState: TextState): void

processDrawIcon

  • processDrawIcon(iconIndex: number, textState: TextState): void

processEscapeCharacter

  • processEscapeCharacter(code: string, textState: TextState): void

processNewLine

processNewPage

processNormalCharacter

  • processNormalCharacter(textState: TextState): void

refreshDimmerBitmap

  • refreshDimmerBitmap(): void

reserveFaceImages

  • reserveFaceImages(): void

resetFontSettings

  • resetFontSettings(): void

resetTextColor

  • resetTextColor(): void

setBackgroundType

  • setBackgroundType(type: number): void

show

  • show(): void

showBackgroundDimmer

  • showBackgroundDimmer(): void

standardBackOpacity

  • standardBackOpacity(): number

standardFontFace

  • standardFontFace(): string

standardFontSize

  • standardFontSize(): number

standardPadding

  • standardPadding(): number

startInput

  • startInput(): boolean

startMessage

  • startMessage(): void

startPause

  • startPause(): void
  • Starts a pause for the message window; this will only be lifted if the user presses a button.

    memberof

    Window_Message

    Returns void

startWait

  • startWait(count: number): void

subWindows

systemColor

  • systemColor(): string

terminateMessage

  • terminateMessage(): void

textColor

  • textColor(n: number): string
  • Returns a text color given a numbered index as a css color string; this index maps directly to the img/system/window.png colors by default.

    memberof

    Window_Base

    Parameters

    • n: number

    Returns string

textPadding

  • textPadding(): number

textWidth

  • textWidth(text: string): number

tpColor

tpCostColor

  • tpCostColor(): string

tpGaugeColor1

  • tpGaugeColor1(): string

tpGaugeColor2

  • tpGaugeColor2(): string

translucentOpacity

  • translucentOpacity(): number

update

  • update(): void

updateBackOpacity

  • updateBackOpacity(): void

updateBackground

  • updateBackground(): void

updateBackgroundDimmer

  • updateBackgroundDimmer(): void

updateClose

  • updateClose(): void

updateInput

  • updateInput(): boolean

updateLoading

  • updateLoading(): boolean

updateMessage

  • updateMessage(): boolean

updateOpen

  • updateOpen(): void

updatePadding

  • updatePadding(): void

updatePlacement

  • updatePlacement(): void

updateShowFast

  • updateShowFast(): void

updateTone

  • updateTone(): void

updateWait

  • updateWait(): boolean

windowHeight

  • windowHeight(): number

windowWidth

  • windowWidth(): number

Generated using TypeDoc