XerrScreenAPI

Stable screen-effect API exposed by com.hiusers.xerr.api.XerrAPI.

Functions

open fun clear(playerId: UUID): Int

abstract fun clear(playerId: UUID, force: Boolean): Int

abstract fun find(playerId: UUID, instanceId: UUID): ScreenEffectHandle?

abstract fun hide(playerId: UUID, effectId: String): Int

abstract fun ids(): Set<String>

open fun play(playerId: UUID, sceneId: String): ScreenEffectHandle

open fun play(player: Player, sceneId: String): ScreenEffectHandle

abstract fun play(playerId: UUID, sceneId: String, variables: Map<String, String>): ScreenEffectHandle

abstract fun play(player: Player, sceneId: String, variables: Map<String, String>): ScreenEffectHandle

abstract fun sceneIds(): Set<String>

open fun show(playerId: UUID, effectId: String): ScreenEffectHandle

open fun show(player: Player, effectId: String): ScreenEffectHandle

abstract fun show(playerId: UUID, effectId: String, variables: Map<String, String>): ScreenEffectHandle

abstract fun show(player: Player, effectId: String, variables: Map<String, String>): ScreenEffectHandle