MCrow
Share
Unturned Events
List of events that be used in Rocket plugins from UnturnedEvents class.
Important Notes
- Always subscribe to events in
Load()
method - Always unsubscribe in
Unload()
to prevent memory leaks - Event handlers must match the exact signature of the event
- Use
ref
parameters when required by the event signature using Rocket.Unturned;
is required
Quick Example
public class ExamplePlugin : RocketPlugin<ExampleConfiguration>
{
protected override void Load()
{
U.Events.OnPlayerConnected += HandlePlayerConnect;
}
protected override void Unload()
{
U.Events.OnPlayerConnected -= HandlePlayerConnect;
}
private void HandlePlayerConnect(UnturnedPlayer player)
{
Logger.Log($"{player.DisplayName} connected!");
}
}
OnPlayerConnected
Called when player joins the server.
private void HandlePlayerConnect(UnturnedPlayer player)
{
UnturnedChat.Say(player, "Welcome to the server!");
}
OnBeforePlayerConnected
Called before player joins the server.
private void HandleBeforeConnect(UnturnedPlayer player)
{
Logger.Log($"Player {player.CharacterName} is connecting...");
}
OnPlayerDisconnected
Called when player leaves server.
private void HandleDisconnect(UnturnedPlayer player)
{
Logger.Log($"{player.DisplayName} left the server");
}
OnPlayerDamaged
Called when player takes damage.
private void HandleDamage(UnturnedPlayer player, ref EDeathCause cause, ref ELimb limb, ref UnturnedPlayer killer, ref Vector3 direction, ref float damage, ref float times, ref bool canDamage)
{
if (killer != null)
{
float totalDamage = damage * times;
Logger.Log($"{killer.DisplayName} hit {player.DisplayName} for {totalDamage} damage!");
}
}
OnShutdown
Called when server begins shutdown.
private void HandleShutdown()
{
Logger.Log("Server is shutting down!");
}
Need help?
If you need assistance with the documentation or have any questions, our community is here to help you: