Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Window_BattleLog


Window_BattleLog

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

class

Window_BattleLog

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected _baseLineStack

_baseLineStack: Array<number>

Protected _closing

_closing: boolean

The closing property; determines if the window is closing.

type

{boolean}

memberof

Window_Base

Protected _cursorAll

_cursorAll: boolean

Protected _cursorFixed

_cursorFixed: boolean

The boolean property that determines if the cursor is fixed(locked to a position).

type

{boolean}

memberof

Window_Selectable

Protected _handlers

_handlers: object

Protected _helpWindow

_helpWindow: any

Protected _index

_index: number

The index property of Window_Selectable; this is used to select items from the list within the window.

type

{number}

memberof

Window_Selectable

Protected _lines

_lines: Array<string>

Protected _methods

_methods: Array<BattleLogMethod>

Protected _opening

_opening: boolean

The opening property; determines if the window is opening.

type

{boolean}

memberof

Window_Base

Protected _scrollX

_scrollX: number

Protected _scrollY

_scrollY: number

Protected _spriteset

_spriteset: Spriteset_Battle

Protected _stayCount

_stayCount: number

Protected _touching

_touching: boolean

Protected _waitCount

_waitCount: number

Protected _waitMode

_waitMode: string

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

addText

  • addText(text: string): void

animationBaseDelay

  • animationBaseDelay(): number

animationNextDelay

  • animationNextDelay(): number

backColor

  • backColor(): string

backPaintOpacity

  • backPaintOpacity(): number

backRect

bottomRow

  • bottomRow(): number

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

callCancelHandler

  • callCancelHandler(): void

callHandler

  • callHandler(symbol: string): void

callNextMethod

  • callNextMethod(): void

callOkHandler

  • callOkHandler(): void

callUpdateHelp

  • callUpdateHelp(): void

canvasToLocalX

  • canvasToLocalX(x: number): number

canvasToLocalY

  • canvasToLocalY(y: number): number

changePaintOpacity

  • changePaintOpacity(enabled: boolean): void

changeTextColor

  • changeTextColor(color: string): void

clear

  • clear(): void

clearItem

  • clearItem(index: number): void

close

  • close(): void

contentsHeight

  • contentsHeight(): number

contentsWidth

  • contentsWidth(): number

convertEscapeCharacters

  • convertEscapeCharacters(text: string): string

createBackBitmap

  • createBackBitmap(): void

createBackSprite

  • createBackSprite(): void

createContents

  • createContents(): void

crisisColor

  • crisisColor(): string

cursorAll

  • cursorAll(): boolean

cursorDown

  • cursorDown(wrap: boolean): void

cursorFixed

  • cursorFixed(): boolean

cursorLeft

  • cursorLeft(wrap: boolean): void

cursorPagedown

  • cursorPagedown(): void

cursorPageup

  • cursorPageup(): void

cursorRight

  • cursorRight(wrap: boolean): void

cursorUp

  • cursorUp(wrap: boolean): void

deactivate

  • deactivate(): void

deathColor

  • deathColor(): string

deselect

  • deselect(): void

dimColor1

  • dimColor1(): string

dimColor2

  • dimColor2(): string

displayAction

displayActionResults

displayAddedStates

displayAffectedStatus

displayAutoAffectedStatus

displayBuffs

  • displayBuffs(target: Game_Battler, buffs: Array<number>, fmt: string): void

displayChangedBuffs

displayChangedStates

displayCounter

displayCritical

displayCurrentState

displayDamage

displayEvasion

displayFailure

displayHpDamage

displayMiss

displayMpDamage

displayReflection

displayRegeneration

displayRemovedStates

displaySubstitute

displayTpDamage

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

drawAllItems

  • drawAllItems(): void

drawBackground

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

drawItem

  • drawItem(index: number): void

drawItemName

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

drawLineText

  • drawLineText(index: number): 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

endAction

ensureCursorVisible

  • ensureCursorVisible(): void

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

hideHelpWindow

  • hideHelpWindow(): void

hitTest

  • hitTest(x: number, y: number): number

hpColor

hpGaugeColor1

  • hpGaugeColor1(): string

hpGaugeColor2

  • hpGaugeColor2(): string

index

  • index(): number

isBusy

  • isBusy(): boolean

isCancelEnabled

  • isCancelEnabled(): boolean

isCancelTriggered

  • isCancelTriggered(): boolean

isClosing

  • isClosing(): boolean

isContentsArea

  • isContentsArea(x: number, y: number): boolean

isCurrentItemEnabled

  • isCurrentItemEnabled(): boolean

isCursorMovable

  • isCursorMovable(): boolean

isCursorVisible

  • isCursorVisible(): boolean

isFastForward

  • isFastForward(): boolean

isHandled

  • isHandled(symbol: string): boolean

isHorizontal

  • isHorizontal(): boolean

isOkEnabled

  • isOkEnabled(): boolean

isOkTriggered

  • isOkTriggered(): boolean

isOpenAndActive

  • isOpenAndActive(): boolean

isOpening

  • isOpening(): boolean

isTouchOkEnabled

  • isTouchOkEnabled(): boolean

isTouchedInsideFrame

  • isTouchedInsideFrame(): boolean

itemHeight

  • itemHeight(): number

itemRect

itemRectForText

itemWidth

  • itemWidth(): number

lineHeight

  • lineHeight(): number

loadWindowSkin

  • loadWindowSkin(): void

makeFontBigger

  • makeFontBigger(): void

makeFontSmaller

  • makeFontSmaller(): void

makeHpDamageText

makeMpDamageText

makeTpDamageText

maxCols

  • maxCols(): number

maxItems

  • maxItems(): number

maxLines

  • maxLines(): number

maxPageItems

  • maxPageItems(): number

maxPageRows

  • maxPageRows(): number

maxTopRow

  • maxTopRow(): number

messageSpeed

  • messageSpeed(): number

mpColor

mpCostColor

  • mpCostColor(): string

mpGaugeColor1

  • mpGaugeColor1(): string

mpGaugeColor2

  • mpGaugeColor2(): string

normalColor

  • normalColor(): string

numLines

  • numLines(): number

obtainEscapeCode

  • obtainEscapeCode(textState: TextState): string

obtainEscapeParam

  • obtainEscapeParam(textState: TextState): number | string

onTouch

  • onTouch(triggered: boolean): 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

performAction

performActionEnd

performActionStart

performCollapse

performCounter

performDamage

performEvasion

performMagicEvasion

performMiss

performRecovery

performReflection

performSubstitute

playBuzzerSound

  • playBuzzerSound(): void

playOkSound

  • playOkSound(): void

popBaseLine

  • popBaseLine(): void

popupDamage

powerDownColor

  • powerDownColor(): string

powerUpColor

  • powerUpColor(): string

processCancel

  • processCancel(): void

processCharacter

  • processCharacter(textState: TextState): void

processCursorMove

  • processCursorMove(): void

processDrawIcon

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

processEscapeCharacter

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

processHandling

  • processHandling(): void

processNewLine

processNewPage

processNormalCharacter

  • processNormalCharacter(textState: TextState): void

processOk

  • processOk(): void

processPagedown

  • processPagedown(): void

processPageup

  • processPageup(): void

processTouch

  • processTouch(): void

processWheel

  • processWheel(): void

push

  • push(methodName: string, ...args: any[]): void

pushBaseLine

  • pushBaseLine(): void

redrawCurrentItem

  • redrawCurrentItem(): void

redrawItem

  • redrawItem(index: number): void

refresh

  • refresh(): void

refreshDimmerBitmap

  • refreshDimmerBitmap(): void

reselect

  • reselect(): void

reserveFaceImages

  • reserveFaceImages(): void

resetFontSettings

  • resetFontSettings(): void

resetScroll

  • resetScroll(): void

resetTextColor

  • resetTextColor(): void

row

  • row(): number

scrollDown

  • scrollDown(): void

scrollUp

  • scrollUp(): void

select

  • select(index: number): void

setBackgroundType

  • setBackgroundType(type: number): void

setBottomRow

  • setBottomRow(row: number): void

setCursorAll

  • setCursorAll(cursorAll: boolean): void

setCursorFixed

  • setCursorFixed(cursorFixed: boolean): void

setHandler

  • setHandler(symbol: string, method: any): void

setHelpWindow

setHelpWindowItem

  • setHelpWindowItem(item: any): void

setSpriteset

setTopRow

  • setTopRow(row: number): void

setWaitMode

  • setWaitMode(waitMode: string): void

show

  • show(): void

showActorAttackAnimation

showAnimation

showAttackAnimation

showBackgroundDimmer

  • showBackgroundDimmer(): void

showEnemyAttackAnimation

showHelpWindow

  • showHelpWindow(): void

showNormalAnimation

  • showNormalAnimation(targets: Game_Battler, animationId: number, mirror: boolean): void

spacing

  • spacing(): number

standardBackOpacity

  • standardBackOpacity(): number

standardFontFace

  • standardFontFace(): string

standardFontSize

  • standardFontSize(): number

standardPadding

  • standardPadding(): number

startAction

startTurn

  • startTurn(): void

systemColor

  • systemColor(): string

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

topRow

  • topRow(): number

tpColor

tpCostColor

  • tpCostColor(): string

tpGaugeColor1

  • tpGaugeColor1(): string

tpGaugeColor2

  • tpGaugeColor2(): string

translucentOpacity

  • translucentOpacity(): number

update

  • update(): void

updateArrows

  • updateArrows(): void

updateBackOpacity

  • updateBackOpacity(): void

updateBackgroundDimmer

  • updateBackgroundDimmer(): void

updateClose

  • updateClose(): void

updateCursor

  • updateCursor(): void

updateHelp

  • updateHelp(): void

updateInputData

  • updateInputData(): void

updateOpen

  • updateOpen(): void

updatePadding

  • updatePadding(): void

updateTone

  • updateTone(): void

updateWait

  • updateWait(): boolean

updateWaitCount

  • updateWaitCount(): boolean

updateWaitMode

  • updateWaitMode(): boolean

wait

  • wait(): void

waitForEffect

  • waitForEffect(): void

waitForMovement

  • waitForMovement(): void

waitForNewLine

  • waitForNewLine(): void

windowHeight

  • windowHeight(): number

windowWidth

  • windowWidth(): number

Generated using TypeDoc