Class TimedWave

Namespace

Exiled.API.Features.Waves

Assembly

Exiled.API.dll

Represents a timed wave.

public class TimedWave

Inheritance

object

TimedWave

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

TimedWave(TimeBasedWave)

Initializes a new instance of the TimedWave class.

public TimedWave(TimeBasedWave wave)

Parameters

wave TimeBasedWave

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

Properties

Announcement

Gets the Respawning.Announcements.WaveAnnouncementBase for this wave.

public WaveAnnouncementBase Announcement { get; }

Property Value

WaveAnnouncementBase

Remarks

Wave must implement Respawning.Waves.IAnnouncedWave.

Base

Gets the base Respawning.Waves.TimeBasedWave.

public TimeBasedWave Base { get; }

Property Value

TimeBasedWave

Faction

Gets the faction of this wave.

public Faction Faction { get; }

Property Value

Faction

IsMiniWave

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

public bool IsMiniWave { get; }

Property Value

bool

MaxAmount

Gets the maximum amount of people that can spawn in this wave.

public int MaxAmount { get; }

Property Value

int

Name

Gets the name of the wave timer.

public string Name { get; }

Property Value

string

SpawnableFaction

Gets the spawnable faction for this wave.

public SpawnableFaction SpawnableFaction { get; }

Property Value

SpawnableFaction

Team

Gets the team of this wave.

public Team Team { get; }

Property Value

Team

Timer

Gets the wave timer instance.

public WaveTimer Timer { get; }

Property Value

WaveTimer

Methods

Destroy()

Destroys this wave.

public void Destroy()

GetTimedWaves()

Get all timed waves.

public static List<TimedWave> GetTimedWaves()

Returns

List<TimedWave>

A list of all timed waves.

PlayAnnouncement()

Plays the announcement for this wave.

public void PlayAnnouncement()

Remarks

Wave must implement Respawning.Waves.IAnnouncedWave.

PopulateQueue(Queue<RoleTypeId>, int)

Populates this wave with the specified amount of roles.

public void PopulateQueue(Queue<RoleTypeId> queue, int amount)

Parameters

queue Queue<RoleTypeId>

The queue to populate.

amount int

The amount of people to populate.

TryGetTimedWave<T>(out TimedWave)

Get the timed wave for the specified type.

public static bool TryGetTimedWave<T>(out TimedWave wave) where T : TimeBasedWave

Parameters

wave TimedWave

The wave type to get.

Returns

bool

A value indicating whether the wave was found.

Type Parameters

T

The type of wave to get. Must be a Respawning.Waves.TimeBasedWave. I.e. Respawning.Waves.NtfSpawnWave or Respawning.Waves.NtfMiniWave.

TryGetTimedWaves(Faction, out List<TimedWave>)

Get the timed waves for the specified faction.

public static bool TryGetTimedWaves(Faction faction, out List<TimedWave> waves)

Parameters

faction Faction

The faction to get the waves for.

waves List<TimedWave>

The waves if found.

Returns

bool

A value indicating whether the wave were found.

TryGetTimedWaves(Team, out List<TimedWave>)

Get the timed waves for the specified faction.

public static bool TryGetTimedWaves(Team team, out List<TimedWave> waves)

Parameters

team Team

The faction to get the waves for.

waves List<TimedWave>

The waves if found.

Returns

bool

A value indicating whether the wave were found.