Package io.github.dennisochulor.tickrate.api

Interface TickRateEvents

public interface TickRateEvents

TickRate related events.

These events are fired when the associated /tick command is run and also when the associated API method is called. Registering event handlers for these events is identical to registering event handlers for Fabric events.

Unlike TickRateAPI, event handlers can be registered before the server has fully initialised.

Note that if any TickRateAPI methods that trigger events are not called on the server thread, then the event will fire off-thread. For regular in-game command executions, events are always fired on-thread.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	TickRateEvents.ChunkFreeze
static interface	TickRateEvents.ChunkRate
static interface	TickRateEvents.ChunkSprint
static interface	TickRateEvents.ChunkStep
static interface	TickRateEvents.EntityFreeze
static interface	TickRateEvents.EntityRate
static interface	TickRateEvents.EntitySprint
static interface	TickRateEvents.EntityStep
static interface	TickRateEvents.ServerFreeze
static interface	TickRateEvents.ServerRate
static interface	TickRateEvents.ServerSprint
static interface	TickRateEvents.ServerStep

Field Summary

Fields

Modifier and Type	Field	Description
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkFreeze>	CHUNK_FREEZE	Called when a chunk is frozen or unfrozen.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkRate>	CHUNK_RATE	Called when the tick rate of a chunk is modified.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkSprint>	CHUNK_SPRINT	Called when a chunk starts sprinting.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkStep>	CHUNK_STEP	Called when a chunk starts stepping.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityFreeze>	ENTITY_FREEZE	Called when an entity is frozen or unfrozen.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityRate>	ENTITY_RATE	Called when the tick rate of an entity has been modified.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntitySprint>	ENTITY_SPRINT	Called when an entity starts sprinting.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityStep>	ENTITY_STEP	Called when an entity starts stepping.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerFreeze>	SERVER_FREEZE	Called when the server is frozen or unfrozen.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerRate>	SERVER_RATE	Called when the tick rate of the server has been modified.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerSprint>	SERVER_SPRINT	Called when the server starts sprinting.
static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerStep>	SERVER_STEP	Called when the server starts stepping.

Field Details

SERVER_RATE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerRate> SERVER_RATE

Called when the tick rate of the server has been modified.

SERVER_FREEZE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerFreeze> SERVER_FREEZE

Called when the server is frozen or unfrozen.

SERVER_STEP

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerStep> SERVER_STEP

Called when the server starts stepping.

SERVER_SPRINT

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ServerSprint> SERVER_SPRINT

Called when the server starts sprinting.

ENTITY_RATE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityRate> ENTITY_RATE

Called when the tick rate of an entity has been modified.

If the entity's rate has been reset, rate will be 0.

ENTITY_FREEZE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityFreeze> ENTITY_FREEZE

Called when an entity is frozen or unfrozen.

ENTITY_STEP

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntityStep> ENTITY_STEP

Called when an entity starts stepping.

ENTITY_SPRINT

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.EntitySprint> ENTITY_SPRINT

Called when an entity starts sprinting.

CHUNK_RATE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkRate> CHUNK_RATE

Called when the tick rate of a chunk is modified.

If the chunk's rate has been reset, rate will be 0.

CHUNK_FREEZE

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkFreeze> CHUNK_FREEZE

Called when a chunk is frozen or unfrozen.

CHUNK_STEP

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkStep> CHUNK_STEP

Called when a chunk starts stepping.

CHUNK_SPRINT

static final net.fabricmc.fabric.api.event.Event<TickRateEvents.ChunkSprint> CHUNK_SPRINT

Called when a chunk starts sprinting.