enum class ServerPhaseExecution stages available to server entrypoints.
BOOTSTRAP,Early, process-lifetime initialization. Only GLOBAL packs may use this phase.
READYA server and its worlds are available. GLOBAL and WORLD packs may use this phase.
enum class ClientPhaseExecution stages available to client entrypoints.
READY,One-time client initialization. Only GLOBAL packs may use this phase.
REGISTRY_SETUP,Client content registration before remote registry validation.
JOINEDA client connection, player, and world are available.
enum class InvocationReasonWhether an entrypoint is running for the first time or being replayed after a reload.
INITIAL_LOAD,The entrypoint is running for the first time at its lifecycle boundary.
HOT_RELOADThe entrypoint is replaying after an accepted script reload or synchronized revision.
enum class ReloadCauseThe operation that caused an entrypoint invocation.
SERVER_START,A server reached its ready lifecycle boundary.
COMMAND,A Katton command requested a script reload.
DATAPACK_RELOAD,Minecraft's datapack reload flow requested a script reload.
SERVER_PACK_SYNC,A client activated a server-authoritative script-pack snapshot.
CLIENT_JOINA client connection gained its local player and level.
sealed interface ScriptInvocationContextCommon metadata supplied to phase-aware entrypoints.
data class BootstrapContext( override val packId: String, override val scope: ScriptPackScope, override val reason: InvocationReason, override val cause: ReloadCause, override val platform: String ) : ScriptInvocationContextInvocation metadata for [ServerPhase.BOOTSTRAP].
data class ServerReadyContext( override val packId: String, override val scope: ScriptPackScope, override val reason: InvocationReason, override val cause: ReloadCause, override val platform: String, val server: MinecraftServer ) : ScriptInvocationContextInvocation metadata for [ServerPhase.READY], including the available [server].
data class ClientReadyContext( override val packId: String, override val scope: ScriptPackScope, override val reason: InvocationReason, override val cause: ReloadCause, override val platform: String, val client: Minecraft ) : ScriptInvocationContextInvocation metadata for [ClientPhase.READY], including the available [client].
data class ClientRegistryContext( override val packId: String, override val scope: ScriptPackScope, override val reason: InvocationReason, override val cause: ReloadCause, override val platform: String, val client: Minecraft ) : ScriptInvocationContextInvocation metadata for [ClientPhase.REGISTRY_SETUP], before remote registry validation.
data class ClientJoinedContext( override val packId: String, override val scope: ScriptPackScope, override val reason: InvocationReason, override val cause: ReloadCause, override val platform: String, val client: Minecraft, val player: LocalPlayer, val level: ClientLevel ) : ScriptInvocationContextInvocation metadata for [ClientPhase.JOINED], including the available [player] and [level].
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class ClientScriptEntrypoint( val phase: ClientPhaseMarks a top-level function as a client script entrypoint.
@Retention(AnnotationRetention.RUNTIME)
@Target(AnnotationTarget.FUNCTION)
annotation class ServerScriptEntrypoint( val phase: ServerPhaseMarks a top-level function as a server script entrypoint.