Class Scp096Role
Defines a role that represents SCP-096.
Inherited Members
Namespace: Exiled.API.Features.Roles
Assembly: Exiled.API.dll
Syntax
public class Scp096Role : FpcRole, IWrapper<PlayerRoleBase>, ISubroutinedScpRole, IHumeShieldRole
Properties
| Improve this Doc View SourceAbilityState
Gets a value indicating SCP-096's ability state.
Declaration
public Scp096AbilityState AbilityState { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096AbilityState |
AttackAbility
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096AttackAbility.
Declaration
public Scp096AttackAbility AttackAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096AttackAbility |
AttackPossible
Gets a value indicating whether or not SCP-096 can attack.
Declaration
public bool AttackPossible { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Base
Gets the PlayerRoles.PlayableScps.Scp096.Scp096Role.
Declaration
public Scp096Role Base { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096Role |
CanReceiveTargets
Gets a value indicating whether or not SCP-096 can receive targets.
Declaration
public bool CanReceiveTargets { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
ChargeAbility
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096ChargeAbility.
Declaration
public Scp096ChargeAbility ChargeAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096ChargeAbility |
ChargeCooldown
Gets or sets the Charge Ability Cooldown.
Declaration
public float ChargeCooldown { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
EnrageCooldown
Gets or sets the amount of time before SCP-096 can be enraged again.
Declaration
public float EnrageCooldown { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
EnragedTimeLeft
Gets or sets enraged time left.
Declaration
public float EnragedTimeLeft { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
HumeShieldModule
Declaration
public HumeShieldModuleBase HumeShieldModule { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.HumeShield.HumeShieldModuleBase |
RageCycleAbility
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096RageCycleAbility.
Declaration
public Scp096RageCycleAbility RageCycleAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096RageCycleAbility |
RageManager
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096RageManager.
Declaration
public Scp096RageManager RageManager { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096RageManager |
RageState
Gets a value indicating SCP-096's rage state.
Declaration
public Scp096RageState RageState { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096RageState |
RemainingChargeDuration
Gets or sets the Charge Ability duration.
Declaration
public float RemainingChargeDuration { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
SubroutineModule
Declaration
public SubroutineManagerModule SubroutineModule { get; }
Property Value
Type | Description |
---|---|
SubroutineManagerModule |
Targets
Gets a System.Collections.Generic.IReadOnlyCollection<T> of Players that are currently targeted by SCP-096.
Declaration
public IReadOnlyCollection<Player> Targets { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IReadOnlyCollection<Player> |
TargetsTracker
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096TargetsTracker.
Declaration
public Scp096TargetsTracker TargetsTracker { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096TargetsTracker |
TotalEnrageTime
Gets or sets enraged time left.
Declaration
public float TotalEnrageTime { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
TryNotToCryAbility
Gets SCP-096's PlayerRoles.PlayableScps.Scp096.Scp096TryNotToCryAbility.
Declaration
public Scp096TryNotToCryAbility TryNotToCryAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp096.Scp096TryNotToCryAbility |
TryNotToCryActive
Gets or sets a value indicating whether the TryNotToCry ability is active.
Declaration
public bool TryNotToCryActive { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean |
TurnedPlayers
Gets a list of players who will be turned away from SCP-096.
Declaration
public static HashSet<Player> TurnedPlayers { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.HashSet<Player> |
Type
Declaration
public override RoleTypeId Type { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.RoleTypeId |
Overrides
Methods
| Improve this Doc View SourceAddTarget(Player)
Adds the specified player
as an SCP-096 target.
Declaration
public bool AddTarget(Player player)
Parameters
Type | Name | Description |
---|---|---|
Player | player | The player to add as a target. |
Returns
Type | Description |
---|---|
System.Boolean | true if target was successfully added. Otherwise, false. |
AddTarget(Player, Boolean)
Adds the specified player
as an SCP-096 target.
Declaration
public bool AddTarget(Player player, bool isLooking)
Parameters
Type | Name | Description |
---|---|---|
Player | player | The player to add as a target. |
System.Boolean | isLooking | Is because player look SCP-096. |
Returns
Type | Description |
---|---|
System.Boolean | true if target was successfully added. Otherwise, false. |
Attack()
Trigger the attack ability.
Declaration
public void Attack()
Calm(Boolean)
Ends SCP-096's enrage cycle.
Declaration
public void Calm(bool clearTime = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | clearTime | Whether or not to clear the remaining enrage time. |
Charge(Single)
Trigger the charge ability.
Declaration
public void Charge(float cooldown = 1F)
Parameters
Type | Name | Description |
---|---|---|
System.Single | cooldown | The cooldown time to set before the charge can be executed again. |
ClearTargets()
Removes all targets from SCP-096's target list.
Declaration
public void ClearTargets()
Enrage(Single)
Enrages SCP-096 for the given amount of times.
Declaration
public void Enrage(float time = 20F)
Parameters
Type | Name | Description |
---|---|---|
System.Single | time | The amount of time to enrage SCP-096. |
GetSpawnChance(List<RoleTypeId>)
Gets the Spawn Chance of SCP-096.
Declaration
public float GetSpawnChance(List<RoleTypeId> alreadySpawned)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.List<PlayerRoles.RoleTypeId> | alreadySpawned | The List of Roles already spawned. |
Returns
Type | Description |
---|---|
System.Single | The Spawn Chance. |
HasTarget(Player)
Returns whether or not the provided player
is a target of SCP-096.
Declaration
public bool HasTarget(Player player)
Parameters
Type | Name | Description |
---|---|---|
Player | player | The player to check. |
Returns
Type | Description |
---|---|
System.Boolean | Whether or not the player is a target of SCP-096. |
IsObserved(Player)
Returns whether or not the provided player
is observed by SCP-096.
Declaration
public bool IsObserved(Player player)
Parameters
Type | Name | Description |
---|---|---|
Player | player | The player to check. |
Returns
Type | Description |
---|---|
System.Boolean | Whether or not the player is observed. |
RemoveTarget(Player)
Removes the specified player
from SCP-096's targets.
Declaration
public bool RemoveTarget(Player player)
Parameters
Type | Name | Description |
---|---|---|
Player | player | The player to remove as a target. |
Returns
Type | Description |
---|---|
System.Boolean | true if target was successfully removed. Otherwise, false. |
ShowRageInput(Single)
Shows the input prompt for the RageCycle ability.
Declaration
public void ShowRageInput(float duration = 10F)
Parameters
Type | Name | Description |
---|---|---|
System.Single | duration | The input prompt duration. |