Skip to content

Interface: EffectsPluginConfig ​

Options for loadEffectsModule: optional overrides for the visual-effects atlas. When omitted, the SDK's defaults are used.

Properties ​

atlasBaseUrl? ​

ts
optional atlasBaseUrl?: string;

Override base URL where the effects atlas files are hosted.


atlasJson? ​

ts
optional atlasJson?: string;

Override filename of the atlas JSON descriptor.


atlasKey? ​

ts
optional atlasKey?: string;

Override texture key used to register the atlas in Phaser.


sizeIndex? ​

ts
optional sizeIndex?: number;

Index selecting the atlas size / variant to load.