Class WaveTimer

Namespace

Exiled.API.Features.Waves

Assembly

Exiled.API.dll

Represents a wave timer.

public class WaveTimer

Inheritance

object

WaveTimer

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

ReflectionExtensions.CopyProperties(object, object)

Constructors

WaveTimer(WaveTimer)

Initializes a new instance of the WaveTimer class.

public WaveTimer(WaveTimer wave)

Parameters

wave WaveTimer

The Respawning.Waves.WaveTimer that this class should be based off of.

Properties

Base

Gets the base Respawning.Waves.WaveTimer.

public WaveTimer Base { get; }

Property Value

WaveTimer

DefaultSpawnInterval

Gets the default amount of time between a respawn of this wave.

public float DefaultSpawnInterval { get; }

Property Value

float

IsMiniWave

Gets a value indicating whether the wave is a mini wave.

public bool IsMiniWave { get; }

Property Value

bool

IsPaused

Gets a value indicating whether this wave is paused.

public bool IsPaused { get; }

Property Value

bool

IsReady

Gets a value indicating whether this wave is ready to spawn.

public bool IsReady { get; }

Property Value

bool

IsRespawnable

Gets a value indicating whether this wave is out of respawns.

public bool IsRespawnable { get; }

Property Value

bool

Name

Gets the name of the wave timer.

public string Name { get; }

Property Value

string

PauseTimeLeft

Gets the amount of time left before this wave unpause.

public TimeSpan PauseTimeLeft { get; }

Property Value

TimeSpan

PausedFor

Gets the amount of time this wave has been paused for.

public TimeSpan PausedFor { get; }

Property Value

TimeSpan

SpawnInterval

Gets the actual amount of time between a respawn of this wave.

public float SpawnInterval { get; }

Property Value

float

TimeLeft

Gets the amount of time left before the wave spawns.

public TimeSpan TimeLeft { get; }

Property Value

TimeSpan

TimePassed

Gets the amount of time passed since the last wave spawned.

public TimeSpan TimePassed { get; }

Property Value

TimeSpan

Methods

AddTime(float)

Add time to the wave timer.

public void AddTime(float seconds)

Parameters

seconds float

The amount of time to add in seconds.

Destroy()

Destroys this wave timer.

public void Destroy()

GetWaveTimers()

Gets all wave timers.

public static List<WaveTimer> GetWaveTimers()

Returns

List<WaveTimer>

A list of all wave timers.

Pause(float)

Pauses this wave timer.

public void Pause(float seconds)

Parameters

seconds float

The amount of time to pause this wave timer for.

Reset(bool)

Resets this wave timer.

public void Reset(bool resetInterval = true)

Parameters

resetInterval bool

A value indicating whether the SpawnInterval should be reset.

SetTime(float)

Set the amount of time before the wave spawns.

public void SetTime(float seconds)

Parameters

seconds float

The amount of time before the wave spawns, in seconds.

SetTime(TimeSpan)

Set the amount of time before the wave spawns.

public void SetTime(TimeSpan time)

Parameters

time TimeSpan

The amount of time before the wave spawns.

TryGetWaveTimers(Faction, out List<WaveTimer>)

Get the wave timers for the specified faction.

public static bool TryGetWaveTimers(Faction faction, out List<WaveTimer> waves)

Parameters

faction Faction

The faction.

waves List<WaveTimer>

The waves, if any.

Returns

bool

A bool indicating if waves were found.

TryGetWaveTimers(Team, out List<WaveTimer>)

Get the wave timers for the specified faction.

public static bool TryGetWaveTimers(Team team, out List<WaveTimer> waves)

Parameters

team Team

The team.

waves List<WaveTimer>

The waves, if any.

Returns

bool

A bool indicating if waves were found.

Unpause()

Unpauses this wave timer.

public void Unpause()

Update()

Update the timer.

public void Update()