Class EscapingEventArgs
Contains all information before a player escapes.
Inherited Members
Namespace: Exiled.Events.EventArgs.Player
Assembly: Exiled.Events.dll
Syntax
public class EscapingEventArgs : IPlayerEvent, IDeniableEvent, IExiledEvent
Constructors
| Improve this Doc View SourceEscapingEventArgs(Player, RoleTypeId, EscapeScenario)
Initializes a new instance of the EscapingEventArgs class.
Declaration
public EscapingEventArgs(Player player, RoleTypeId newRole, EscapeScenario escapeScenario)
Parameters
Type | Name | Description |
---|---|---|
Player | player | |
PlayerRoles.RoleTypeId | newRole | |
EscapeScenario | escapeScenario |
EscapingEventArgs(Player, RoleTypeId, EscapeScenario, SpawnableTeamType, Single)
Initializes a new instance of the EscapingEventArgs class.
Declaration
public EscapingEventArgs(Player player, RoleTypeId newRole, EscapeScenario escapeScenario, SpawnableTeamType teamToGrantTickets, float ticketsToGrant)
Parameters
Type | Name | Description |
---|---|---|
Player | player | |
PlayerRoles.RoleTypeId | newRole | |
EscapeScenario | escapeScenario | |
Respawning.SpawnableTeamType | teamToGrantTickets | A Respawning.SpawnableTeamType that RespawnTickets will be initialized with. |
System.Single | ticketsToGrant | A langword_csharp_float that RespawnTickets will be initialized with. |
EscapingEventArgs(Player, RoleTypeId, EscapeScenario, KeyValuePair<SpawnableTeamType, Single>)
Initializes a new instance of the EscapingEventArgs class.
Declaration
public EscapingEventArgs(Player player, RoleTypeId newRole, EscapeScenario escapeScenario, KeyValuePair<SpawnableTeamType, float> respawnTickets)
Parameters
Type | Name | Description |
---|---|---|
Player | player | |
PlayerRoles.RoleTypeId | newRole | |
EscapeScenario | escapeScenario | |
System.Collections.Generic.KeyValuePair<Respawning.SpawnableTeamType, System.Single> | respawnTickets |
Properties
| Improve this Doc View SourceEscapeScenario
Gets or sets the EscapeScenario that will represent for this player.
Declaration
public EscapeScenario EscapeScenario { get; set; }
Property Value
Type | Description |
---|---|
EscapeScenario |
IsAllowed
Gets or sets a value indicating whether or not the player can escape.
Declaration
public bool IsAllowed { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
NewRole
Gets or sets the role that will be assigned when the player escapes.
Declaration
public RoleTypeId NewRole { get; set; }
Property Value
Type | Description |
---|---|
PlayerRoles.RoleTypeId |
Player
Gets the player who's escaping.
Declaration
public Player Player { get; }
Property Value
Type | Description |
---|---|
Player |
RespawnTickets
Gets or sets the RespawnTickets that will represent the amount of tickets granted to a specific Respawning.SpawnableTeamType after the player escapes.
Declaration
public KeyValuePair<SpawnableTeamType, float> RespawnTickets { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.KeyValuePair<Respawning.SpawnableTeamType, System.Single> |