Common

SceneServerApi

top.katton.api.scenecommon/src/main/kotlin/top/katton/api/scene/SceneServerApi.kt

Cancellation targets the original recipients; this is not a playback acknowledgement.

Members

Jump directly to declarations on this page.

• RemoteSceneHandleClass
• playPlayerSceneFunction
• playNearbySceneFunction

RemoteSceneHandle

RemoteSceneHandleCommonClass

class RemoteSceneHandle internal constructor(val instanceId: UUID, private var recipients: List<ServerPlayer>)

Cancellation targets the original recipients; this is not a playback acknowledgement.

playPlayerScene

playPlayerSceneCommonFunction

fun playPlayerScene(player: ServerPlayer, id: String, context: SceneContext = SceneContext(player.position(), player.uuid), revision: String = ScriptExecutionContext.currentScriptRevision() ?: "1"): RemoteSceneHandle

Trigger a registered client scene. Call on the server thread.

playNearbyScene

playNearbySceneCommonFunction

fun playNearbyScene(level: ServerLevel, origin: Vec3, radius: Double, id: String, context: SceneContext = SceneContext(origin), revision: String = ScriptExecutionContext.currentScriptRevision() ?: "1"): RemoteSceneHandle

Select recipients once, in the specified dimension and radius; late arrivals do not receive a replay.