ScreenSprite | RPGMakerMV Library

Hierarchy

Sprite
- ScreenSprite

Implements

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ScreenSprite(): ScreenSprite

Overrides Sprite.constructor
- Defined in js/rmmv-ts/src/rpg_core.d.ts:1856
The sprite which covers the entire game screen.

class

ScreenSprite

constructor

Returns ScreenSprite

Properties

Protected _anchor

_anchor: ObservablePoint

Protected _blue

_blue: number

Protected _bounds

_bounds: Bounds

Protected _boundsID

_boundsID: number

Protected _boundsRect

_boundsRect: Rectangle

Protected _cacheAsBitmap

_cacheAsBitmap: boolean

Protected _cacheData

_cacheData: boolean

Protected _colorText

_colorText: string

Protected _destroyed

_destroyed: boolean

Protected _enabledFilters

_enabledFilters: Filter[] | null

Protected _filters

_filters: Filter[] | null

Protected _graphics

_graphics: Graphics

Protected _green

_green: number

Protected _height

_height: number

Protected _lastBoundsID

_lastBoundsID: number

Protected _localBoundsRect

_localBoundsRect: Rectangle

Protected _mask

_mask: Graphics | Sprite

Protected _red

_red: number

Protected _texture

_texture: Texture

Protected _textureID

_textureID: number

Protected _textureTrimmedID

_textureTrimmedID: number

Protected _tint

_tint: number

Protected _tintRGB

_tintRGB: number

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

anchor: ObservablePoint

blendMode

blendMode: number

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[] | null

height

height: number

hitArea

hitArea: Rectangle | Circle | Ellipse | Polygon | RoundedRectangle

interactive

interactive: boolean

interactiveChildren

interactiveChildren: boolean

localTransform

localTransform: Matrix

mask

mask: Graphics | Sprite

name

name: string | null

Protected onChildrenChange

onChildrenChange: function

Type declaration

- (...args: any[]): void
- Parameters
  - Rest ...args: any[]
  Returns void

opacity

opacity: number

The opacity of the sprite (0 to 255).

property: opacity
type: Number

parent

parent: Container

pivot

pivot: Point | ObservablePoint

pluginName

pluginName: string

position

position: Point | ObservablePoint

renderable

renderable: boolean

rotation

rotation: number

scale

scale: Point | ObservablePoint

skew

skew: ObservablePoint

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

width

width: number

worldAlpha

worldAlpha: number

worldTransform

worldTransform: Matrix

worldVisible

worldVisible: boolean

x

x: number

y

y: number

Static EventEmitter

EventEmitter: object

Type declaration

constructor: function
- new __type(): EventEmitter
- - Defined in node_modules/@types/pixi.js/index.d.ts:2810
  Returns EventEmitter
prefixed: string | boolean

Static prefixed

prefixed: string | boolean

Methods

Protected _cacheAsBitmapDestroy

_cacheAsBitmapDestroy(options: boolean | any): void

Inherited from DisplayObject._cacheAsBitmapDestroy
- Defined in node_modules/@types/pixi.js/index.d.ts:295
Parameters
- options: boolean | any
Returns void

Protected _calculateBounds

_calculateBounds(): void

Inherited from Sprite._calculateBounds

Overrides Container._calculateBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:1209
Returns void

Protected _calculateCachedBounds

_calculateCachedBounds(): Rectangle

Inherited from DisplayObject._calculateCachedBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:292
Returns Rectangle

Protected _destroyCachedDisplayObject

_destroyCachedDisplayObject(): void

Inherited from DisplayObject._destroyCachedDisplayObject
- Defined in node_modules/@types/pixi.js/index.d.ts:294
Returns void

Protected _getCachedLocalBounds

_getCachedLocalBounds(): Rectangle

Inherited from DisplayObject._getCachedLocalBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:293
Returns Rectangle

Protected _initCachedDisplayObject

_initCachedDisplayObject(renderer: WebGLRenderer): void

Inherited from DisplayObject._initCachedDisplayObject
- Defined in node_modules/@types/pixi.js/index.d.ts:289
Parameters
- renderer: WebGLRenderer
Returns void

Protected _initCachedDisplayObjectCanvas

_initCachedDisplayObjectCanvas(renderer: CanvasRenderer): void

Inherited from DisplayObject._initCachedDisplayObjectCanvas
- Defined in node_modules/@types/pixi.js/index.d.ts:291
Parameters
- renderer: CanvasRenderer
Returns void

Protected _onTextureUpdate

_onTextureUpdate(): void

Inherited from Sprite._onTextureUpdate
- Defined in node_modules/@types/pixi.js/index.d.ts:1207
Returns void

Protected _recursivePostUpdateTransform

_recursivePostUpdateTransform(): void

Inherited from DisplayObject._recursivePostUpdateTransform
- Defined in node_modules/@types/pixi.js/index.d.ts:355
Returns void

Protected _renderCachedCanvas

_renderCachedCanvas(renderer: CanvasRenderer): void

Inherited from DisplayObject._renderCachedCanvas
- Defined in node_modules/@types/pixi.js/index.d.ts:290
Parameters
- renderer: CanvasRenderer
Returns void

Protected _renderCachedWebGL

_renderCachedWebGL(renderer: WebGLRenderer): void

Inherited from DisplayObject._renderCachedWebGL
- Defined in node_modules/@types/pixi.js/index.d.ts:288
Parameters
- renderer: WebGLRenderer
Returns void

Protected _renderCanvas

_renderCanvas(renderer: CanvasRenderer): void

Inherited from Sprite._renderCanvas

Overrides Container._renderCanvas
- Defined in node_modules/@types/pixi.js/index.d.ts:1213
Parameters
- renderer: CanvasRenderer
Returns void

Protected _renderWebGL

_renderWebGL(renderer: WebGLRenderer): void

Inherited from Sprite._renderWebGL

Overrides Container._renderWebGL
- Defined in node_modules/@types/pixi.js/index.d.ts:1212
Parameters
- renderer: WebGLRenderer
Returns void

addChild

addChild<T>(child: T, ...additionalChildren: DisplayObject[]): T

Inherited from Container.addChild
- Defined in node_modules/@types/pixi.js/index.d.ts:254
Type parameters
- T: DisplayObject
Parameters
- child: T
- Rest ...additionalChildren: DisplayObject[]
Returns T

addChildAt

addChildAt<T>(child: T, index: number): T

Inherited from Container.addChildAt
- Defined in node_modules/@types/pixi.js/index.d.ts:255
Type parameters
- T: DisplayObject
Parameters
- child: T
- index: number
Returns T

addListener

addListener(event: InteractionEventTypes, fn: function, context?: any): this

Inherited from DisplayObject.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/pixi.js/index.d.ts:377
Parameters
- event: InteractionEventTypes
- fn: function
  - - (event: InteractionEvent): void
    - Parameters
      - event: InteractionEvent
      Returns void
- Optional context: any
Returns this

calculateBounds

calculateBounds(): void

Inherited from Container.calculateBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:264
Returns void

Protected calculateTrimmedVertices

calculateTrimmedVertices(): void

Inherited from Sprite.calculateTrimmedVertices
- Defined in node_modules/@types/pixi.js/index.d.ts:1210
Returns void

calculateVertices

calculateVertices(): void

Inherited from Sprite.calculateVertices
- Defined in node_modules/@types/pixi.js/index.d.ts:1208
Returns void

Protected containerUpdateTransform

containerUpdateTransform(): void

Inherited from Container.containerUpdateTransform
- Defined in node_modules/@types/pixi.js/index.d.ts:266
Returns void

containsPoint

containsPoint(point: Point): boolean

Inherited from Sprite.containsPoint
- Defined in node_modules/@types/pixi.js/index.d.ts:1215
Parameters
- point: Point
Returns boolean

destroy

destroy(options?: DestroyOptions | boolean): void

Inherited from Sprite.destroy

Overrides Container.destroy
- Defined in node_modules/@types/pixi.js/index.d.ts:1216
Parameters
- Optional options: DestroyOptions | boolean
Returns void

Protected displayObjectUpdateTransform

displayObjectUpdateTransform(): void

Inherited from DisplayObject.displayObjectUpdateTransform
- Defined in node_modules/@types/pixi.js/index.d.ts:354
Returns void

emit

emit(event: string | symbol, ...args: any[]): boolean

Inherited from EventEmitter.emit
- Defined in node_modules/@types/pixi.js/index.d.ts:2852
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>

Inherited from EventEmitter.eventNames
- Defined in node_modules/@types/pixi.js/index.d.ts:2827
Return an array listing the events for which the emitter has registered listeners.

Returns Array<string | symbol>

getBounds

getBounds(skipUpdate?: boolean, rect?: Rectangle): Rectangle

Inherited from DisplayObject.getBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:356
Parameters
- Optional skipUpdate: boolean
- Optional rect: Rectangle
Returns Rectangle

getChildAt

getChildAt(index: number): DisplayObject

Inherited from Container.getChildAt
- Defined in node_modules/@types/pixi.js/index.d.ts:259
Parameters
- index: number
Returns DisplayObject

getChildByName

getChildByName(name: string): DisplayObject

Inherited from Container.getChildByName
- Defined in node_modules/@types/pixi.js/index.d.ts:246
Parameters
- name: string
Returns DisplayObject

getChildIndex

getChildIndex(child: DisplayObject): number

Inherited from Container.getChildIndex
- Defined in node_modules/@types/pixi.js/index.d.ts:257
Parameters
- child: DisplayObject
Returns number

getGlobalPosition

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

Inherited from DisplayObject.getGlobalPosition
- Defined in node_modules/@types/pixi.js/index.d.ts:303
Parameters
- Optional point: Point
- Optional skipUpdate: boolean
Returns Point

getLocalBounds

getLocalBounds(): Rectangle

Inherited from Sprite.getLocalBounds

Overrides DisplayObject.getLocalBounds
- Defined in node_modules/@types/pixi.js/index.d.ts:1214
Returns Rectangle

listeners

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

Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2835
Return the listeners registered for a given event.

Parameters
- event: string | symbol
  
  The event name.
Returns Function[]
Inherited from EventEmitter.listeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2844
Check if there listeners for a given event. If exists argument is not true lists listeners.

Parameters
- event: string | symbol
  
  The event name.
- exists: boolean
  
  Only check if there are listeners.
Returns boolean

off

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

Inherited from Container.off

Overrides DisplayObject.off
- Defined in node_modules/@types/pixi.js/index.d.ts:281
Parameters
- event: "added" | "removed" | string
- Optional fn: Function
- Optional context: any
Returns this

on

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

Inherited from Container.on

Overrides DisplayObject.on
- Defined in node_modules/@types/pixi.js/index.d.ts:277
Parameters
- event: "added" | "removed"
- fn: function
  - - (displayObject: DisplayObject): void
    - Parameters
      - displayObject: DisplayObject
      Returns void
- Optional context: any
Returns this
Inherited from Container.on

Overrides DisplayObject.on
- Defined in node_modules/@types/pixi.js/index.d.ts:279
Parameters
- event: string
- fn: Function
- Optional context: any
Returns this

Protected onAnchorUpdate

onAnchorUpdate(): void

Inherited from Sprite.onAnchorUpdate
- Defined in node_modules/@types/pixi.js/index.d.ts:1211
Returns void

once

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

Inherited from Container.once

Overrides DisplayObject.once
- Defined in node_modules/@types/pixi.js/index.d.ts:274
Parameters
- event: "added" | "removed"
- fn: function
  - - (displayObject: DisplayObject): void
    - Parameters
      - displayObject: DisplayObject
      Returns void
- Optional context: any
Returns this
Inherited from Container.once

Overrides DisplayObject.once
- Defined in node_modules/@types/pixi.js/index.d.ts:276
Parameters
- event: string
- fn: Function
- Optional context: any
Returns this

removeAllListeners

removeAllListeners(event: InteractionEventTypes): this

Inherited from DisplayObject.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:375
Parameters
- event: InteractionEventTypes
Returns this

removeChild

removeChild(child: DisplayObject): DisplayObject

Inherited from Container.removeChild
- Defined in node_modules/@types/pixi.js/index.d.ts:260
Parameters
- child: DisplayObject
Returns DisplayObject

removeChildAt

removeChildAt(index: number): DisplayObject

Inherited from Container.removeChildAt
- Defined in node_modules/@types/pixi.js/index.d.ts:261
Parameters
- index: number
Returns DisplayObject

removeChildren

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

Inherited from Container.removeChildren
- Defined in node_modules/@types/pixi.js/index.d.ts:262
Parameters
- Optional beginIndex: number
- Optional endIndex: number
Returns DisplayObject[]

removeListener

removeListener(event: InteractionEventTypes, fn?: function, context?: any): this

Inherited from DisplayObject.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/pixi.js/index.d.ts:374
Parameters
- event: InteractionEventTypes
- Optional fn: function
  - - (event: InteractionEvent): void
    - Parameters
      - event: InteractionEvent
      Returns void
- Optional context: any
Returns this

renderAdvancedWebGL

renderAdvancedWebGL(renderer: WebGLRenderer): void

Inherited from Container.renderAdvancedWebGL
- Defined in node_modules/@types/pixi.js/index.d.ts:268
Parameters
- renderer: WebGLRenderer
Returns void

renderCanvas

renderCanvas(renderer: CanvasRenderer): void

Inherited from Container.renderCanvas

Overrides DisplayObject.renderCanvas
- Defined in node_modules/@types/pixi.js/index.d.ts:271
Parameters
- renderer: CanvasRenderer
Returns void

renderWebGL

renderWebGL(renderer: WebGLRenderer): void

Inherited from Container.renderWebGL

Overrides DisplayObject.renderWebGL
- Defined in node_modules/@types/pixi.js/index.d.ts:267
Parameters
- renderer: WebGLRenderer
Returns void

setBlack

setBlack(): void

- Defined in js/rmmv-ts/src/rpg_core.d.ts:1871
Sets black to the color of the screen sprite.

method

setBlack

Returns void

setChildIndex

setChildIndex(child: DisplayObject, index: number): void

Inherited from Container.setChildIndex
- Defined in node_modules/@types/pixi.js/index.d.ts:258
Parameters
- child: DisplayObject
- index: number
Returns void

setColor

setColor(r?: number, g?: number, b?: number): void

- Defined in js/rmmv-ts/src/rpg_core.d.ts:1888
Sets the color of the screen sprite by values.

method

setColor

Parameters
- Optional r: number
  
  The red value in the range (0, 255)
- Optional g: number
  
  The green value in the range (0, 255)
- Optional b: number
  
  The blue value in the range (0, 255)
Returns void

setMaxListeners

setMaxListeners(): this

Inherited from EventEmitter.setMaxListeners
- Defined in node_modules/@types/pixi.js/index.d.ts:2905
This function doesn't apply anymore.

deprecated

Returns this

setParent

setParent(container: Container): Container

Inherited from DisplayObject.setParent
- Defined in node_modules/@types/pixi.js/index.d.ts:368
Parameters
- container: Container
Returns Container

setTransform

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

Inherited from DisplayObject.setTransform
- Defined in node_modules/@types/pixi.js/index.d.ts:369
Parameters
- Optional x: number
- Optional y: number
- Optional scaleX: number
- Optional scaleY: number
- Optional rotation: number
- Optional skewX: number
- Optional skewY: number
- Optional pivotX: number
- Optional pivotY: number
Returns DisplayObject

setWhite

setWhite(): void

- Defined in js/rmmv-ts/src/rpg_core.d.ts:1878
Sets white to the color of the screen sprite.

method

setWhite

Returns void

swapChildren

swapChildren(child: DisplayObject, child2: DisplayObject): void

Inherited from Container.swapChildren
- Defined in node_modules/@types/pixi.js/index.d.ts:256
Parameters
- child: DisplayObject
- child2: DisplayObject
Returns void

toGlobal

toGlobal(position: PointLike): Point
toGlobal<T>(position: PointLike, point?: T, skipUpdate?: boolean): T

Inherited from DisplayObject.toGlobal
- Defined in node_modules/@types/pixi.js/index.d.ts:359
Parameters
- position: PointLike
Returns Point
Inherited from DisplayObject.toGlobal
- Defined in node_modules/@types/pixi.js/index.d.ts:361
Type parameters
- T: PointLike
Parameters
- position: PointLike
- Optional point: T
- Optional skipUpdate: boolean
Returns T

toLocal

toLocal(position: PointLike, from?: DisplayObject): Point
toLocal<T>(position: PointLike, from?: DisplayObject, point?: T, skipUpdate?: boolean): T

Inherited from DisplayObject.toLocal
- Defined in node_modules/@types/pixi.js/index.d.ts:363
Parameters
- position: PointLike
- Optional from: DisplayObject
Returns Point
Inherited from DisplayObject.toLocal
- Defined in node_modules/@types/pixi.js/index.d.ts:365
Type parameters
- T: PointLike
Parameters
- position: PointLike
- Optional from: DisplayObject
- Optional point: T
- Optional skipUpdate: boolean
Returns T

trackedPointers

trackedPointers(): object

Implementation of InteractiveTarget.trackedPointers

Inherited from DisplayObject.trackedPointers
- Defined in node_modules/@types/pixi.js/index.d.ts:319
Returns object
- [key: number]: InteractionTrackingData

updateTransform

updateTransform(): void

Inherited from Container.updateTransform

Overrides DisplayObject.updateTransform
- Defined in node_modules/@types/pixi.js/index.d.ts:263
Returns void

Static from

from(source: number | string | BaseTexture | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement): Sprite

Inherited from Sprite.from
- Defined in node_modules/@types/pixi.js/index.d.ts:1218
Parameters
- source: number | string | BaseTexture | HTMLImageElement | HTMLCanvasElement | HTMLVideoElement
Returns Sprite

Static fromFrame

fromFrame(frameId: string): Sprite

Inherited from Sprite.fromFrame
- Defined in node_modules/@types/pixi.js/index.d.ts:1219
Parameters
- frameId: string
Returns Sprite

Static fromImage

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

Inherited from Sprite.fromImage
- Defined in node_modules/@types/pixi.js/index.d.ts:1220
Parameters
- imageId: string
- Optional crossorigin: boolean
- Optional scaleMode: number
Returns Sprite

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns ScreenSprite

Properties

Protected _anchor

Protected _blue

Protected _bounds

Protected _boundsID

Protected _boundsRect

Protected _cacheAsBitmap

Protected _cacheData

Protected _colorText

Protected _destroyed

Protected _enabledFilters

Protected _filters

Protected _graphics

Protected _green

Protected _height

Protected _lastBoundsID

Protected _localBoundsRect

Protected _mask

Protected _red

Protected _texture

Protected _textureID

Protected _textureTrimmedID

Protected _tint

Protected _tintRGB

Protected _transformID

Protected _transformTrimmedID

Protected _width

accessible

accessibleHint

accessibleTitle

alpha

anchor

blendMode

buttonMode

cacheAsBitmap

Protected cachedTint

children

cursor

defaultCursor

filterArea

filters

height

hitArea

interactive

interactiveChildren

localTransform

mask

name

Protected onChildrenChange

Type declaration

Parameters

Rest ...args: any[]

Returns void

opacity

parent

pivot

pluginName

position

renderable

rotation

scale

skew

tabIndex

texture

Protected textureDirty

tint

transform

vertexData

Protected vertexTrimmedData

visible

width