Class Effect

Index

Constructors

Methods

destroy getEffectId getId getIsBuiltIn getPixiFilter getProperties getProperty getProvider init serialize setId setProperty update deserialize

Constructors

constructor

new Effect(effectId: string, properties?: Record<string, any>): Effect
Parameters
- effectId: string
- Optionalproperties: Record<string, any>
Returns Effect

Methods

destroy

destroy(): void
Returns void

getEffectId

getEffectId(): string
Returns string

getId

getId(): string
Returns string

getIsBuiltIn

getIsBuiltIn(): boolean
Returns boolean

getPixiFilter

getPixiFilter(): Pixi.Filter
Returns Pixi.Filter

getProperties

getProperties(): Map<string, any>
Returns Map<string, any>

getProperty

getProperty(propertyName: string): any
Parameters
- propertyName: string
Returns any

getProvider

getProvider(): string
Returns string

init

init(): void
Returns void

serialize

serialize(): {
    effectId: string;
    id: string;
    properties: [string, any][];
    provider: string;
}
Returns { effectId: string; id: string; properties: [string, any][]; provider: string }

setId

setId(id: string): void
Parameters
- id: string
Returns void

setProperty

setProperty(propertyName: string, value: any): void
Parameters
- propertyName: string
- value: any
Returns void

update

update(clipTime: number): void
Parameters
- clipTime: number
Returns void

`Static`deserialize

deserialize(data: object): Effect
Parameters
- data: object
Returns Effect