Class CreatejsSprite

inherited createjs.Sprite

Hierarchy (View Summary)

SpriteBase
- CreatejsSprite
  - CreatejsSprite

Implements

ICreatejsDisplayObject<PixiSprite>

Index

Constructors

Properties

_off? alpha children? currentFrame regX regY rotation scaleX scaleY skewX skewY spriteSheet visible x y

Accessors

Methods

_tick addEventListener advance dispatchEvent gotoAndStop initialize removeAllEventListeners removeEventListener updateBlendModeForPixi

Constructors

constructor

new CreatejsSprite(...args: TCreatejsSpriteConstructorArgs): core.CreatejsSprite
Parameters
- ...args: TCreatejsSpriteConstructorArgs
Returns core.CreatejsSprite
Overrides SpriteBase.constructor
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:43

Properties

`Optional`_off

_off?: boolean

alpha

alpha: number

`Optional`children

children?: ICreatejsSyncNode[]

currentFrame

currentFrame: number

regX

regX: number

regY

regY: number

rotation

rotation: number

scaleX

scaleX: number

scaleY

scaleY: number

skewX

skewX: number

skewY

skewY: number

spriteSheet

spriteSheet: ICreatejsSpriteSheet

visible

visible: boolean

x

x: number

y

y: number

Accessors

mask

get mask(): TCreatejsMask
Returns TCreatejsMask
Implementation of ICreatejsDisplayObject.mask
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:55
set mask(value: TCreatejsMask): void
Parameters
- value: TCreatejsMask
Returns void
Implementation of ICreatejsDisplayObject.mask
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:56

pixi

get pixi(): PixiSprite
Returns PixiSprite
Implementation of ICreatejsDisplayObject.pixi
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:45

Methods

_tick

_tick(evt: object): void
Parameters
- evt: object
Returns void
Inherited from SpriteBase._tick
- Defined in pixi-animate-container/types/createjs/modules/core.d.ts:43

addEventListener

addEventListener(
    type: string,
    cb: ICreatejsInteractionEventDelegate | CreatejsButtonHelper,
    useCapture?: boolean,
): ICreatejsInteractionEventDelegate | CreatejsButtonHelper
Parameters
- type: string
- cb: ICreatejsInteractionEventDelegate | CreatejsButtonHelper
- OptionaluseCapture: boolean
Returns ICreatejsInteractionEventDelegate | CreatejsButtonHelper
Implementation of ICreatejsDisplayObject.addEventListener

Overrides SpriteBase.addEventListener
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:57

advance

advance(time?: number): void
The Pixi mirror is only updated through gotoAndStop, so the spritesheet animation must not self-advance when the original Sprite._tick runs (tick delegation would otherwise advance the createjs side alone and leave the display behind).
Parameters
- Optionaltime: number
Returns void
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:52

dispatchEvent

dispatchEvent(evt: string | object): boolean
Parameters
- evt: string | object
Returns boolean
Inherited from SpriteBase.dispatchEvent
- Defined in pixi-animate-container/types/createjs/modules/core.d.ts:42

gotoAndStop

gotoAndStop(frameOrAnimation: string | number): void
Parameters
- frameOrAnimation: string | number
Returns void
Overrides SpriteBase.gotoAndStop
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:54

initialize

initialize(...args: TCreatejsSpriteConstructorArgs): void
Parameters
- ...args: TCreatejsSpriteConstructorArgs
Returns void
Overrides SpriteBase.initialize
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:44

removeAllEventListeners

removeAllEventListeners(type?: string): void
Parameters
- Optionaltype: string
Returns void
Implementation of ICreatejsDisplayObject.removeAllEventListeners

Overrides SpriteBase.removeAllEventListeners
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:59

removeEventListener

removeEventListener(
    type: string,
    cb: ICreatejsInteractionEventDelegate,
    useCapture?: boolean,
): void
Parameters
- type: string
- cb: ICreatejsInteractionEventDelegate
- OptionaluseCapture: boolean
Returns void
Implementation of ICreatejsDisplayObject.removeEventListener

Overrides SpriteBase.removeEventListener
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:58

updateBlendModeForPixi

updateBlendModeForPixi(mode: BLEND_MODES): void
Parameters
- mode: BLEND_MODES
Returns void
Implementation of ICreatejsDisplayObject.updateBlendModeForPixi
- Defined in pixi-animate-container/types/createjs/modules/Sprite.d.ts:53