events.md

Events

OrbisProxy provides lifecycle events that plugins can subscribe to using:

proxy:on("event_name", function(event)
    -- handle event
end)

Currently available events:

session_connect

Triggered when a player initiates a connection and the proxy is about to select a backend server.

This event is mutable.
You may modify certain fields to influence routing behavior.

Event Fields

Field	Type	Mutable	Description
target_server	string	✅ Yes	The backend server the player will be connected to.
player	Player	❌ No	The player object initiating the connection.

Example

proxy:on("session_connect", function(event)
    log("Player connecting to: " .. event.target_server)
    event.target_server = "lobby"
end)

session_connected

Triggered after a player has successfully connected to the backend server.

This event is read-only and cannot influence routing anymore.

Event Fields

Field	Type	Mutable	Description
server	string	❌ No	The backend server the player is connected to.
player	Player	❌ No	The connected player object.

Example

proxy:on("session_connected", function(event)
    log("Player successfully connected to " .. event.target_server)
end)

session_disconnected

Triggered after a player has disconnected from the proxy.

This event is read-only.

Event Fields

Field	Type	Mutable	Description
player	Player	❌ No	The player object.

Example

proxy:on("session_disconnected", function(event)
    log("Player disconnected " .. event.player:getName())
end)

proxy_ready

Triggered after the proxy is ready to accept player connections.

This event is read-only.

Event Fields

None

Example

proxy:on("proxy_ready", function(event)
    log("Proxy is ready to accept connections")
end)

proxy_shutdown

Triggered after proxy shut down was initiated.

This event is read-only.

Event Fields

None

Example

proxy:on("proxy_shutdown", function(event)
    log("Proxy is shutting down")
end)