Class ArenaClientEvents

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

The moments of an arena match, as C# events for code that wants to react to them: audio, camera, effects, analytics.

public static class ArenaClientEvents

Inheritance

object

ArenaClientEvents

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Designers get the same moments as ECA triggers on the ArenaTemplate; this is the programmer's side of the same hook. Raised by UITKArenaHud from the match state broadcast, so everything here is server-timed.

Properties

Current

The match the local player is in, or null when not in one. Set by the HUD from the state broadcast.

public static ArenaMatchStateBroadcast? Current { get; }

Property Value

ArenaMatchStateBroadcast?

IsSpectating

True while the local player is standing in an arena match they have no seat in.

public static bool IsSpectating { get; }

Property Value

bool

Events

OnArenaEvent

A moment of play the server announced: a kill, a flag, a warning. Feeds the kill feed.

public static event Action<ArenaEventBroadcast> OnArenaEvent

Event Type

Action<ArenaEventBroadcast>

OnCountdownTick

Each second of the start countdown, with the seconds left. 0 is the start itself.

public static event Action<int> OnCountdownTick

Event Type

Action<int>

OnMatchEnded

The match ended, with the full result.

public static event Action<ArenaResultsBroadcast> OnMatchEnded

Event Type

Action<ArenaResultsBroadcast>

OnMatchLive

The match went live.

public static event Action OnMatchLive

Event Type

Action

OnMatchState

Every match state the server sent, as it arrives. The scoreboard draws from this.

public static event Action<ArenaMatchStateBroadcast> OnMatchState

Event Type

Action<ArenaMatchStateBroadcast>

OnReadyCheck

A ready check started or moved. The HUD's prompt draws from this.

public static event Action<ArenaReadyCheckBroadcast> OnReadyCheck

Event Type

Action<ArenaReadyCheckBroadcast>

OnTeamScored

A team's score changed. Team index, new score.

public static event Action<int, int> OnTeamScored

Event Type

Action<int, int>