Screen Effects

Automatically controls AnimpostFx (Screen Effects)

core.effects.screen.play

Registers an effect to be played

core.effects.screen.play(effectName, prio)

• effectName: string
• prio?: number
  • Highest registered screen effect will be played
  • Default: 10

core.effects.screen.getPlaying

Returns the lists of registered effects

core.effects.screen.getPlaying()

Return:

• effects: table<string, number>

core.effects.screen.isPlaying

Returns true if the effect is registered

core.effects.screen.isPlaying(effectName)

• effectName: string

Return:

• isPlaying: boolean

core.effects.screen.stop

Unregisters an effect

core.effects.screen.stop(effectName)

• effectName: string

core.effects.screen.stopAll

Unregisters all effects

core.effects.screen.stopAll(effectName)

• effectName: string

core.effects.screen.getNextEffect

Gets the effect with the highest prio

core.effects.screen.getNextEffect(effectName)

Return:

• nextEffect: string or nil