Class Respawn

A set of tools to handle team respawns more easily.

Inheritance

System.Object

Respawn

Inherited Members

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Exiled.API.Features

Assembly: Exiled.API.dll

Syntax

public static class Respawn

Properties

ChaosTickets

Gets or sets the amount of spawn tickets belonging to the Chaos Insurgency.

Declaration

public static float ChaosTickets { get; set; }

Property Value

Type	Description
System.Single

See Also

NtfTickets

ChaosVan

Gets the Chaos Van's UnityEngine.GameObject.

Declaration

public static GameObject ChaosVan { get; }

Property Value

Type	Description
UnityEngine.GameObject

IsSpawning

Gets a value indicating whether or not a team is currently being spawned or the animations are playing for a team.

Declaration

public static bool IsSpawning { get; }

Property Value

Type	Description
System.Boolean

NextKnownTeam

Gets or sets the next known Respawning.SpawnableTeamType that will spawn.

Declaration

public static SpawnableTeamType NextKnownTeam { get; set; }

Property Value

Type	Description
Respawning.SpawnableTeamType

NextTeamTime

Gets a System.DateTime indicating the moment in UTC time the next respawn wave will occur.

Declaration

public static DateTime NextTeamTime { get; }

Property Value

Type	Description
System.DateTime

NtfHelicopter

Gets the NTF Helicopter's UnityEngine.GameObject.

Declaration

public static GameObject NtfHelicopter { get; }

Property Value

Type	Description
UnityEngine.GameObject

NtfTickets

Gets or sets the amount of spawn tickets belonging to the NTF.

Declaration

public static float NtfTickets { get; set; }

Property Value

Type	Description
System.Single

See Also

ChaosTickets

ProtectedCanShoot

Gets or sets a value indicating whether or not spawn protected players can shoot.

Declaration

public static bool ProtectedCanShoot { get; set; }

Property Value

Type	Description
System.Boolean

ProtectedTeams

Gets a System.Collections.Generic.List<T> of PlayerRoles.Team that have spawn protection.

Declaration

public static List<Team> ProtectedTeams { get; }

Property Value

Type	Description
System.Collections.Generic.List<PlayerRoles.Team>

ProtectionEnabled

Gets or sets a value indicating whether or not spawn protection is enabled.

Declaration

public static bool ProtectionEnabled { get; set; }

Property Value

Type	Description
System.Boolean

ProtectionTime

Gets or sets the spawn protection time, in seconds.

Declaration

public static float ProtectionTime { get; set; }

Property Value

Type	Description
System.Single

TimeUntilNextPhase

Gets or sets the amount of seconds before the next respawn phase will occur.

Declaration

public static float TimeUntilNextPhase { get; set; }

Property Value

Type	Description
System.Single

TimeUntilSpawnWave

Gets a System.TimeSpan indicating the amount of time before the next respawn wave will occur.

Declaration

public static TimeSpan TimeUntilSpawnWave { get; }

Property Value

Type	Description
System.TimeSpan

Methods

ForceWave(SpawnableTeamType, Boolean)

Forces a spawn of the given Respawning.SpawnableTeamType.

Declaration

public static void ForceWave(SpawnableTeamType team, bool playEffects = false)

Parameters

Type	Name	Description
Respawning.SpawnableTeamType	team	The Respawning.SpawnableTeamType to spawn.
System.Boolean	playEffects	Whether or not effects will be played with the spawn.

GrantTickets(SpawnableTeamType, Single)

Grants tickets to a Respawning.SpawnableTeamType.

Declaration

public static void GrantTickets(SpawnableTeamType team, float amount)

Parameters

Type	Name	Description
Respawning.SpawnableTeamType	team	The Respawning.SpawnableTeamType to grant tickets to.
System.Single	amount	The amount of tickets to grant.

ModifyTickets(SpawnableTeamType, Single)

Modify tickets from a Respawning.SpawnableTeamType.

Declaration

public static void ModifyTickets(SpawnableTeamType team, float amount)

Parameters

Type	Name	Description
Respawning.SpawnableTeamType	team	The Respawning.SpawnableTeamType to modify tickets from.
System.Single	amount	The amount of tickets to modify.

PlayEffect(RespawnEffectType)

Play an effect when a certain class spawns.

Declaration

public static void PlayEffect(RespawnEffectType effect)

Parameters

Type	Name	Description
RespawnEffectType	effect	The effect to be played.

PlayEffect(Byte)

Play an effect when a certain class spawns.

Declaration

public static void PlayEffect(byte effect)

Parameters

Type	Name	Description
System.Byte	effect	The effect to be played.

PlayEffects(RespawnEffectType[])

Play effects when a certain class spawns.

Declaration

public static void PlayEffects(RespawnEffectType[] effects)

Parameters

Type	Name	Description
RespawnEffectType[]	effects	The effects to be played.

PlayEffects(Byte[])

Play effects when a certain class spawns.

Declaration

public static void PlayEffects(byte[] effects)

Parameters

Type	Name	Description
System.Byte[]	effects	The effects to be played.

RemoveTickets(SpawnableTeamType, Single)

Removes tickets from a Respawning.SpawnableTeamType.

Declaration

public static void RemoveTickets(SpawnableTeamType team, float amount)

Parameters

Type	Name	Description
Respawning.SpawnableTeamType	team	The Respawning.SpawnableTeamType to remove tickets from.
System.Single	amount	The amount of tickets to remove.

SummonChaosInsurgencyVan(Boolean)

Summons the ChaosInsurgency van.

Declaration

public static void SummonChaosInsurgencyVan(bool playMusic = true)

Parameters

Type	Name	Description
System.Boolean	playMusic	Whether or not to play the Chaos Insurgency spawn music.

SummonNtfChopper()

Summons the NTF chopper.

Declaration

public static void SummonNtfChopper()