Link Search Menu Expand Document
rmmz-types

Window_Base.d overview

Table of contents

utils

EscapeCharacter (type alias)

Signature

export declare type EscapeCharacter = 'C' | 'I' | 'PX' | 'PY' | 'FS' | '{' | '}'

TextState (type alias)

Signature

export declare type TextState = {
  text: string
  index: number
  x: number
  y: number
  width: number
  height: number
  startX: number
  startY: number
  rtl: boolean
  buffer: string
  drawing: boolean
  outputWidth: number
  outputHeight: number
}

Window_Base (class)

Window_Base

The superclass of all windows within the game.

Signature

export declare class Window_Base {
  constructor(rect: Rectangle)
}

destroy (method)

Signature

destroy(options?: PIXIDestroyOptions): void

checkRectObject (method)

Signature

checkRectObject(rect: Rectangle): void

lineHeight (method)

Signature

lineHeight(): number

itemWidth (method)

Signature

itemWidth(): number

itemHeight (method)

Signature

itemHeight(): number

itemPadding (method)

Signature

itemPadding(): number

baseTextRect (method)

Signature

baseTextRect(): Rectangle

loadWindowskin (method)

Signature

loadWindowskin(): void

updatePadding (method)

Signature

updatePadding(): void

updateBackOpacity (method)

Signature

updateBackOpacity(): void

fittingHeight (method)

Signature

fittingHeight(numLines: number): number

updateTone (method)

Signature

updateTone(): void

createContents (method)

Signature

createContents(): void

destroyContents (method)

Signature

destroyContents(): void

contentsWidth (method)

Signature

contentsWidth(): number

contentsHeight (method)

Signature

contentsHeight(): number

resetFontSettings (method)

Signature

resetFontSettings(): void

resetTextColor (method)

Signature

resetTextColor(): void

update (method)

Signature

update(): void

updateOpen (method)

Signature

updateOpen(): void

updateClose (method)

Signature

updateClose(): void

open (method)

Signature

open(): void

close (method)

Signature

close(): void

isOpening (method)

Signature

isOpening(): boolean

isClosing (method)

Signature

isClosing(): boolean

show (method)

Signature

show(): void

hide (method)

Signature

hide(): void

activate (method)

Signature

activate(): void

deactivate (method)

Signature

deactivate(): void

systemColor (method)

Signature

systemColor(): string

translucentOpacity (method)

Signature

translucentOpacity(): number

changeTextColor (method)

Signature

changeTextColor(color: string): void

changeOutlineColor (method)

Signature

changeOutlineColor(color: string): void

changePaintOpacity (method)

Signature

changePaintOpacity(enabled: boolean | number): void

drawRect (method)

Signature

drawRect(x: number, y: number, width: number, height: number): void

drawText (method)

Signature

drawText(text: string | number, x: number, y: number, maxWidth?: number, align?: CanvasTextAlign): void

textWidth (method)

Signature

textWidth(text: string): number

drawTextEx (method)

Signature

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

textSizeEx (method)

Signature

textSizeEx(text: string): {
    width: number
    height: number
  }

createTextState (method)

Signature

createTextState(text: string, x: number, y: number, width: number): TextState

processAllText (method)

Signature

processAllText(textState: TextState): void

flushTextState (method)

Signature

flushTextState(textState: TextState): void

createTextBuffer (method)

Signature

createTextBuffer(rtl: boolean): "" | "‫"

convertEscapeCharacters (method)

Signature

convertEscapeCharacters(text: string): string

actorName (method)

Signature

actorName(n: ActorID): string

partyMemberName (method)

Signature

partyMemberName(n: number): string

processCharacter (method)

Signature

processCharacter(textState: TextState): void

processControlCharacter (method)

Signature

processControlCharacter(textState: TextState, c: string): void

processNewLine (method)

Signature

processNewLine(textState: TextState): void

obtainEscapeCode (method)

Signature

obtainEscapeCode(textState: TextState): string

obtainEscapeParam (method)

Signature

obtainEscapeParam(textState: TextState): number

processEscapeCharacter (method)

Signature

processEscapeCharacter(code: EscapeCharacter, textState: TextState): void

processColorChange (method)

Signature

processColorChange(colorIndex: number): void

processDrawIcon (method)

Signature

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

makeFontBigger (method)

Signature

makeFontBigger(): void

makeFontSmaller (method)

Signature

makeFontSmaller(): void

calcTextHeight (method)

Signature

calcTextHeight(
    textState: Partial<TextState> & {
      text: string
    }
  ): number

maxFontSizeInLine (method)

Signature

maxFontSizeInLine(line: string): number

drawIcon (method)

Signature

drawIcon(iconIndex: number, x: number, y: number): void

drawFace (method)

Signature

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

drawCharacter (method)

Signature

drawCharacter(characterName: string, characterIndex: number, x: number, y: number): void

drawItemName (method)

Signature

drawItemName(item: DataItemBase | null, x: number, y: number, width: number): void

drawCurrencyValue (method)

Signature

drawCurrencyValue(value: number, unit: string, x: number, y: number, width: number): void

setBackgroundType (method)

Signature

setBackgroundType(type: TextWindowBackgroundType): void

showBackgroundDimmer (method)

Signature

showBackgroundDimmer(): void

createDimmerSprite (method)

Signature

createDimmerSprite(): void

hideBackgroundDimmer (method)

Signature

hideBackgroundDimmer(): void

updateBackgroundDimmer (method)

Signature

updateBackgroundDimmer(): void

refreshDimmerBitmap (method)

Signature

refreshDimmerBitmap(): void

playCursorSound (method)

Signature

playCursorSound(): void

playOkSound (method)

Signature

playOkSound(): void

playBuzzerSound (method)

Signature

playBuzzerSound(): void

_opening (property)

Signature

_opening: boolean

_closing (property)

Signature

_closing: boolean

_dimmerSprite (property)

Signature

_dimmerSprite: Sprite<Bitmap> | null