Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Spriteset_Battle


Spriteset_Battle

The set of sprites on the battle screen.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

Protected constructor

Properties

_actorSprites

_actorSprites: Sprite_Actor[]

Protected _anchor

_back1Sprite

_back1Sprite: TilingSprite

_back2Sprite

_back2Sprite: TilingSprite

_backgroundSprite

_backgroundSprite: Sprite

_baseSprite

_baseSprite: Sprite

_battleField

_battleField: Sprite

_battlebackLocated

_battlebackLocated: boolean

_blackScreen

_blackScreen: ScreenSprite

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

_enemySprites

_enemySprites: Sprite_Enemy[]

_fadeSprite

_fadeSprite: ScreenSprite

Protected _filters

_filters: Filter[] | null

_flashSprite

_flashSprite: ScreenSprite

Protected _height

_height: number

Protected _lastBoundsID

_lastBoundsID: number

Protected _localBoundsRect

_localBoundsRect: Rectangle

Protected _mask

_mask: Graphics | Sprite

_pictureContainer

_pictureContainer: Sprite

Protected _texture

_texture: Texture

Protected _textureID

_textureID: number

Protected _textureTrimmedID

_textureTrimmedID: number

_timerSprite

_timerSprite: Sprite_Timer

Protected _tint

_tint: number

Protected _tintRGB

_tintRGB: number

_tone

_tone: number[]

_toneFilter

_toneFilter: ToneFilter

_toneSprite

_toneSprite: ToneSprite

Protected _transformID

_transformID: number

Protected _transformTrimmedID

_transformTrimmedID: number

Protected _width

_width: number

accessible

accessible: boolean

accessibleHint

accessibleHint: string | null

accessibleTitle

accessibleTitle: string | null

alpha

alpha: number

anchor

bitmap

bitmap: Bitmap

The image for the sprite.

property

bitmap

blendMode

blendMode: number

The blend mode to be applied to the sprite.

property

blendMode

buttonMode

buttonMode: boolean

cacheAsBitmap

cacheAsBitmap: boolean

Protected cachedTint

cachedTint: number

children

children: DisplayObject[]

cursor

cursor: string

defaultCursor

defaultCursor: string

filterArea

filterArea: Rectangle

filters

filters: Filter[]

Sets the filters for the sprite.

property

filters

height

height: number

hitArea

interactive

interactive: boolean

interactiveChildren

interactiveChildren: boolean

localTransform

localTransform: Matrix

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 width of the sprite without the scale.

property

width

opaque

opaque: boolean

parent

parent: Container

pivot

pluginName

pluginName: string

point

point: Point

The origin point of the sprite. (0,0) to (1,1).

property

anchor

position

renderable

renderable: boolean

rotation

rotation: number

The rotation of the sprite in radians.

property

rotation

scale

scale: Point

The scale factor of the sprite.

property

scale

skew

spriteId

spriteId: number

[read-only] The array of children of the sprite.

property

children

tabIndex

tabIndex: number

texture

texture: Texture

Protected textureDirty

textureDirty: boolean

tint

tint: number

transform

transform: TransformBase

vertexData

vertexData: Float32Array

Protected vertexTrimmedData

vertexTrimmedData: Float32Array

visible

visible: boolean

The visibility of the sprite.

property

visible

voidFilter

voidFilter: Filter

width

width: number

worldAlpha

worldAlpha: number

worldTransform

worldTransform: Matrix

worldVisible

worldVisible: boolean

x

x: number

The x coordinate of the sprite.

property

x

y

y: number

The y coordinate of the sprite.

property

y

Static EventEmitter

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

Type declaration

Static _counter

_counter: number

Number of the created objects.

static
property

_counter

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 _onTextureUpdate

  • _onTextureUpdate(): void

Protected _recursivePostUpdateTransform

  • _recursivePostUpdateTransform(): void

Protected _renderCachedCanvas

Protected _renderCachedWebGL

Protected _renderCanvas

Protected _renderWebGL

addChild

addChildAt

addListener

autotileType

  • autotileType(z: number): number

battleback1Bitmap

battleback1Name

  • battleback1Name(): string

battleback2Bitmap

battleback2Name

  • battleback2Name(): string

battlerSprites

calculateBounds

  • calculateBounds(): void

Protected calculateTrimmedVertices

  • calculateTrimmedVertices(): void

calculateVertices

  • calculateVertices(): void

compareEnemySprite

Protected containerUpdateTransform

  • containerUpdateTransform(): void

containsPoint

  • containsPoint(point: Point): boolean

createActors

  • createActors(): void

createBackground

  • createBackground(): void

createBaseSprite

  • createBaseSprite(): void

createBattleField

  • createBattleField(): void

createBattleback

  • createBattleback(): void

createCanvasToneChanger

  • createCanvasToneChanger(): void

createEnemies

  • createEnemies(): void

createLowerLayer

  • createLowerLayer(): void

createPictures

  • createPictures(): void

createScreenSprites

  • createScreenSprites(): void

createTimer

  • createTimer(): void

createToneChanger

  • createToneChanger(): void

createUpperLayer

  • createUpperLayer(): void

createWebGLToneChanger

  • createWebGLToneChanger(): void

defaultBattleback1Name

  • defaultBattleback1Name(): string

defaultBattleback2Name

  • defaultBattleback2Name(): string

destroy

Protected displayObjectUpdateTransform

  • displayObjectUpdateTransform(): void

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>

getBlendColor

  • getBlendColor(): number[]

getBounds

getChildAt

getChildByName

getChildIndex

getColorTone

  • getColorTone(): number[]

getGlobalPosition

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

getLocalBounds

initialize

  • initialize(bitmap?: Bitmap): void

isAnimationPlaying

  • isAnimationPlaying(): boolean

isAnyoneMoving

  • isAnyoneMoving(): boolean
  • Returns true if any sprite actor or enemy is moving.

    memberof

    Spriteset_Battle

    Returns boolean

    Representing whether any battle participants are moving.

isBusy

  • isBusy(): boolean

isEffecting

  • isEffecting(): boolean

listeners

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

locateBattleback

  • locateBattleback(): void

move

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

normalBattleback1Name

  • normalBattleback1Name(): string

normalBattleback2Name

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

Protected onAnchorUpdate

  • onAnchorUpdate(): void

once

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

overworldBattleback1Name

  • overworldBattleback1Name(): string

overworldBattleback2Name

  • overworldBattleback2Name(): string

removeAllListeners

removeChild

removeChildAt

removeChildren

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

removeListener

renderAdvancedWebGL

renderCanvas

renderWebGL

setBlendColor

  • setBlendColor(color: number[]): void

setChildIndex

setColorTone

  • setColorTone(tone: number[]): void

setFrame

  • setFrame(x: number, y: number, width: number, height: number): void
  • Sets the rectagle of the bitmap that the sprite displays.

    method

    setFrame

    Parameters

    • x: number

      The x coordinate of the frame

    • y: number

      The y coordinate of the frame

    • width: number

      The width of the frame

    • height: number

      The height of the frame

    Returns void

setMaxListeners

  • setMaxListeners(): this

setParent

setTransform

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

shipBattleback1Name

  • shipBattleback1Name(): string

shipBattleback2Name

  • shipBattleback2Name(): string

swapChildren

terrainBattleback1Name

  • terrainBattleback1Name(type: number): string
  • Given the specified terrtain type, return the battleback 1 name.

    memberof

    Spriteset_Battle

    Parameters

    • type: number

      Terrain type.

    Returns string

    Name of the terrtain battleback 1 bitmap.

terrainBattleback2Name

  • terrainBattleback2Name(type: number): string
  • Given the specified terrain type, return the battleback 2 name.

    memberof

    Spriteset_Battle

    Parameters

    • type: number

      Terrain type.

    Returns string

    Name of the terrain battleback 2 bitmap.

toGlobal

toLocal

trackedPointers

  • trackedPointers(): {}

update

  • update(): void

updateActors

  • updateActors(): void

updateBattleback

  • updateBattleback(): void

updateCanvasToneChanger

  • updateCanvasToneChanger(): void

updatePosition

  • updatePosition(): void

updateScreenSprites

  • updateScreenSprites(): void

updateToneChanger

  • updateToneChanger(): void

Private updateTransform

  • updateTransform(): void

updateWebGLToneChanger

  • updateWebGLToneChanger(): void

Static from

Static fromFrame

  • fromFrame(frameId: string): Sprite

Static fromImage

  • fromImage(imageId: string, crossorigin?: boolean, scaleMode?: number): Sprite

Generated using TypeDoc