Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Window_ScrollText


Window_ScrollText

The window for displaying scrolling text. No frame is displayed, but it is handled as a window for convenience.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Protected _cacheAsBitmap

_cacheAsBitmap: boolean

Protected _cacheData

_cacheData: boolean

Protected Readonly _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[] | null

Protected _filters

_filters: Filter[] | null

Protected _lastBoundsID

_lastBoundsID: number

Protected _localBoundsRect

_localBoundsRect: Rectangle

Protected _mask

_mask: Graphics | Sprite

accessible

accessible: boolean

accessibleHint

accessibleHint: string | null

accessibleTitle

accessibleTitle: string | null

active

active: boolean

The active state for the window.

property

active

alpha

alpha: number

backOpacity

backOpacity: number

The opacity of the window background (0 to 255).

property

backOpacity

buttonMode

buttonMode: boolean

cacheAsBitmap

cacheAsBitmap: boolean

children

children: DisplayObject[]

contents

contents: Bitmap

The bitmap used for the window contents.

property

contents

contentsOpacity

contentsOpacity: number

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

property

contentsOpacity

cursor

cursor: string

defaultCursor

defaultCursor: string

downArrowVisible

downArrowVisible: boolean

The visibility of the down scroll arrow.

property

downArrowVisible

filterArea

filterArea: Rectangle

filters

filters: Filter[] | null

height

height: number

hitArea

innerHeight

innerHeight: number

The height of the content area in pixels.

innerRect

innerRect: Rectangle

The rectangle of the content area

innerWidth

innerWidth: number

The width of the content area in pixels.

interactive

interactive: boolean

interactiveChildren

interactiveChildren: boolean

localTransform

localTransform: Matrix

margin

margin: number

The size of the margin for the window background.

property

margin

mask

name

name: string | null

Protected onChildrenChange

onChildrenChange: (...args: any[]) => void

Type declaration

    • (...args: any[]): void
    • Parameters

      • Rest ...args: any[]

      Returns void

opacity

opacity: number

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

property

opacity

openness

openness: number

The openness of the window (0 to 255).

property

openness

origin

origin: Point

The origin point of the window for scrolling.

property

origin

padding

padding: number

The width of the window in pixels.

property

width

parent

parent: Container

pause

pause: boolean

The visibility of the pause sign.

property

pause

pivot

position

renderable

renderable: boolean

rotation

rotation: number

scale

skew

tabIndex

tabIndex: number

transform

transform: TransformBase

upArrowVisible

upArrowVisible: boolean

The visibility of the up scroll arrow.

property

upArrowVisible

visible

visible: boolean

width

width: number

windowskin

windowskin: Bitmap

The image used as a window skin.

property

windowskin

worldAlpha

worldAlpha: number

worldTransform

worldTransform: Matrix

worldVisible

worldVisible: boolean

x

x: number

y

y: number

Static EventEmitter

EventEmitter: { constructor: any; prefixed: string | boolean }

Type declaration

Static _faceHeight

_faceHeight: number

Static _faceWidth

_faceWidth: number

Static _iconHeight

_iconHeight: number

Static _iconWidth

_iconWidth: number

Static prefixed

prefixed: string | boolean

Methods

Protected _cacheAsBitmapDestroy

  • _cacheAsBitmapDestroy(options: boolean | any): void

Protected _calculateBounds

  • _calculateBounds(): void

Protected _calculateCachedBounds

Protected _destroyCachedDisplayObject

  • _destroyCachedDisplayObject(): void

Protected _getCachedLocalBounds

Protected _initCachedDisplayObject

Protected _initCachedDisplayObjectCanvas

Protected _recursivePostUpdateTransform

  • _recursivePostUpdateTransform(): void

Protected _renderCachedCanvas

Protected _renderCachedWebGL

Protected _renderCanvas

Protected _renderWebGL

activate

  • activate(): void

actorName

  • actorName(actorIndex: number): string

addChild

addChildAt

addChildToBack

addInnerChild

addListener

calcTextHeight

  • calcTextHeight(textState: TextState, all: boolean): number

calculateBounds

  • calculateBounds(): void

canvasToLocalX

  • canvasToLocalX(x: number): number

canvasToLocalY

  • canvasToLocalY(y: number): number

changePaintOpacity

  • changePaintOpacity(enabled: boolean): void

changeTextColor

  • changeTextColor(color: string): void

close

  • close(): void

Protected containerUpdateTransform

  • containerUpdateTransform(): void

contentsHeight

  • contentsHeight(): number

contentsWidth

  • contentsWidth(): number

convertEscapeCharacters

  • convertEscapeCharacters(text: string): string

createContents

  • createContents(): void

crisisColor

  • crisisColor(): string

deactivate

  • deactivate(): void

deathColor

  • deathColor(): string

destroy

  • destroy(): void

dimColor1

  • dimColor1(): string

dimColor2

  • dimColor2(): string

Protected displayObjectUpdateTransform

  • displayObjectUpdateTransform(): void

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): void

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): void
  • 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 void

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

drawShape

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

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol

      The event name.

    • Rest ...args: any[]

      Arguments that are passed to registered listeners

    Returns boolean

    true if the event had listeners, else false.

eventNames

  • eventNames(): Array<string | symbol>

fastForwardRate

  • fastForwardRate(): 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

getBounds

getChildAt

getChildByName

getChildIndex

getGlobalPosition

  • getGlobalPosition(point?: Point, skipUpdate?: boolean): Point

getLocalBounds

hide

  • hide(): void

hideBackgroundDimmer

  • hideBackgroundDimmer(): void

hpColor

hpGaugeColor1

  • hpGaugeColor1(): string

hpGaugeColor2

  • hpGaugeColor2(): string

initialize

  • initialize(x?: number, y?: number, width?: number, height?: number): void

isClosed

  • isClosed(): boolean

isClosing

  • isClosing(): boolean

isFastForward

  • isFastForward(): boolean

isOpen

  • isOpen(): boolean

isOpening

  • isOpening(): boolean

lineHeight

  • lineHeight(): number

listeners

  • listeners(event: string | symbol): Function[]
  • listeners(event: string | symbol, exists: boolean): boolean

loadWindowSkin

  • loadWindowSkin(): void

makeFontBigger

  • makeFontBigger(): void

makeFontSmaller

  • makeFontSmaller(): void

move

  • move(x?: number, y?: number, width?: number, height?: number): void
  • Sets the x, y, width, and height all at once.

    method

    move

    Parameters

    • Optional x: number

      The x coordinate of the window

    • Optional y: number

      The y coordinate of the window

    • Optional width: number

      The width of the window

    • Optional height: number

      The height of the window

    Returns void

moveCursorBy

  • moveCursorBy(x: number, y: number): void

moveInnerChildrenBy

  • moveInnerChildrenBy(x: number, y: number): void

mpColor

mpCostColor

  • mpCostColor(): string

mpGaugeColor1

  • mpGaugeColor1(): string

mpGaugeColor2

  • mpGaugeColor2(): string

normalColor

  • normalColor(): string

obtainEscapeCode

  • obtainEscapeCode(textState: TextState): string

obtainEscapeParam

  • obtainEscapeParam(textState: string | TextState): number | string

off

  • off(event: "added" | "removed" | string, fn?: Function, context?: any): this

on

  • on(event: "added" | "removed", fn: (displayObject: DisplayObject) => void, context?: any): this
  • on(event: string, fn: Function, context?: any): this

once

  • once(event: "added" | "removed", fn: (displayObject: DisplayObject) => void, context?: any): this
  • once(event: string, fn: Function, context?: any): this

open

  • open(): void

paramchangeTextColor

  • paramchangeTextColor(change: number): rm.types.Color
  • 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 rm.types.Color

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

refresh

  • refresh(): void

refreshDimmerBitmap

  • refreshDimmerBitmap(): void

removeAllListeners

removeChild

removeChildAt

removeChildren

  • removeChildren(beginIndex?: number, endIndex?: number): DisplayObject[]

removeListener

renderAdvancedWebGL

renderCanvas

renderWebGL

reserveFaceImages

  • reserveFaceImages(): void

resetFontSettings

  • resetFontSettings(): void

resetTextColor

  • resetTextColor(): void

scrollSpeed

  • scrollSpeed(): number

setBackgroundType

  • setBackgroundType(type: number): void

setChildIndex

setCursorRect

  • setCursorRect(x?: number, y?: number, width?: number, height?: number): void
  • Sets the position of the command cursor.

    method

    setCursorRect

    Parameters

    • Optional x: number

      The x coordinate of the cursor

    • Optional y: number

      The y coordinate of the cursor

    • Optional width: number

      The width of the cursor

    • Optional height: number

      The height of the cursor

    Returns void

setMaxListeners

  • setMaxListeners(): this

setParent

setTone

  • setTone(r: number, g: number, b: number): void
  • Changes the color of the background.

    method

    setTone

    Parameters

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

    Returns void

setTransform

  • setTransform(x?: number, y?: number, scaleX?: number, scaleY?: number, rotation?: number, skewX?: number, skewY?: number, pivotX?: number, pivotY?: number): DisplayObject

show

  • show(): void

showBackgroundDimmer

  • showBackgroundDimmer(): void

standardBackOpacity

  • standardBackOpacity(): number

standardFontFace

  • standardFontFace(): string

standardFontSize

  • standardFontSize(): number

standardPadding

  • standardPadding(): number

startMessage

  • startMessage(): void

swapChildren

systemColor

  • systemColor(): string

terminateMessage

  • terminateMessage(): void

textColor

  • textColor(n: number): string

textPadding

  • textPadding(): number

textWidth

  • textWidth(text: string): number

toGlobal

toLocal

tpColor

tpCostColor

  • tpCostColor(): string

tpGaugeColor1

  • tpGaugeColor1(): string

tpGaugeColor2

  • tpGaugeColor2(): string

trackedPointers

  • trackedPointers(): {}

translucentOpacity

  • translucentOpacity(): number

update

  • update(): void

updateBackOpacity

  • updateBackOpacity(): void

updateBackgroundDimmer

  • updateBackgroundDimmer(): void

updateClose

  • updateClose(): void

updateMessage

  • updateMessage(): void

updateOpen

  • updateOpen(): void

updatePadding

  • updatePadding(): void

updateTone

  • updateTone(): void

Private updateTransform

  • updateTransform(): void

Generated using TypeDoc