Class Scp173Role

Defines a role that represents SCP-173.

Inheritance
System.Object
TypeCastObject<Role>
Role
FpcRole
Scp173Role
Implements
IWrapper<PlayerRoles.PlayerRoleBase>
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Exiled.API.Features.Roles
Assembly: Exiled.API.dll
Syntax
public class Scp173Role : FpcRole, IWrapper<PlayerRoleBase>, ISubroutinedScpRole, IHumeShieldRole

Properties

| Improve this Doc View Source

AudioPlayer

Gets the SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173AudioPlayer.

Declaration
public Scp173AudioPlayer AudioPlayer { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173AudioPlayer
| Improve this Doc View Source

Base

Gets the PlayerRoles.PlayableScps.Scp173.Scp173Role instance.

Declaration
public Scp173Role Base { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173Role
| Improve this Doc View Source

BlinkCooldown

Gets or sets the amount of time before SCP-173 can blink.

Declaration
public float BlinkCooldown { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

BlinkDistance

Gets a value indicating the max distance that SCP-173 can move in a blink. Factors in BreakneckActive.

Declaration
public float BlinkDistance { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

BlinkReady

Gets or sets a value indicating whether or not SCP-173 is able to blink.

Declaration
public bool BlinkReady { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BlinkTimer

Gets SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173BlinkTimer.

Declaration
public Scp173BlinkTimer BlinkTimer { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173BlinkTimer
| Improve this Doc View Source

BreakneckActive

Gets or sets a value indicating whether or not SCP-173's breakneck speed is active.

Declaration
public bool BreakneckActive { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

BreakneckSpeedsAbility

Gets SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173BreakneckSpeedsAbility.

Declaration
public Scp173BreakneckSpeedsAbility BreakneckSpeedsAbility { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173BreakneckSpeedsAbility
| Improve this Doc View Source

HumeShieldModule

Declaration
public HumeShieldModuleBase HumeShieldModule { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.HumeShield.HumeShieldModuleBase
| Improve this Doc View Source

IsObserved

Gets a value indicating whether or not SCP-173 is currently being viewed by one or more players.

Declaration
public bool IsObserved { get; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

MaxMovementSpeed

Gets SCP-173's max move speed.

Declaration
public float MaxMovementSpeed { get; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

MovementModule

Gets SCP-173's movement module.

Declaration
public Scp173MovementModule MovementModule { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173MovementModule
| Improve this Doc View Source

MovementSpeed

Gets the SCP-173's movement speed.

Declaration
public override float MovementSpeed { get; }
Property Value
Type Description
System.Single
Overrides
| Improve this Doc View Source

ObserversTracker

Gets SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173ObserversTracker.

Declaration
public Scp173ObserversTracker ObserversTracker { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173ObserversTracker
| Improve this Doc View Source

ObservingPlayers

Gets a System.Collections.Generic.IEnumerable<T> of players that are currently viewing SCP-173. Can be empty.

Declaration
public IEnumerable<Player> ObservingPlayers { get; }
Property Value
Type Description
System.Collections.Generic.IEnumerable<Player>
| Improve this Doc View Source

RemainingBreakneckCooldown

Gets or sets the amount of time before SCP-173 can use breakneck speed again.

Declaration
public float RemainingBreakneckCooldown { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

RemainingTantrumCooldown

Gets or sets the amount of time before SCP-173 can place a tantrum.

Declaration
public float RemainingTantrumCooldown { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SimulatedStare

Gets or sets SCP-173's simulated stare. SCP-173 will be treated as though it is being looked at while this value is greater than 0.

Declaration
public float SimulatedStare { get; set; }
Property Value
Type Description
System.Single
| Improve this Doc View Source

SubroutineModule

Declaration
public SubroutineManagerModule SubroutineModule { get; }
Property Value
Type Description
SubroutineManagerModule
| Improve this Doc View Source

TantrumAbility

Gets SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173TantrumAbility.

Declaration
public Scp173TantrumAbility TantrumAbility { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173TantrumAbility
| Improve this Doc View Source

TeleportAbility

Gets SCP-173's PlayerRoles.PlayableScps.Scp173.Scp173TeleportAbility.

Declaration
public Scp173TeleportAbility TeleportAbility { get; }
Property Value
Type Description
PlayerRoles.PlayableScps.Scp173.Scp173TeleportAbility
| Improve this Doc View Source

TurnedPlayers

Gets a list of players who will be turned away from SCP-173.

Declaration
public static HashSet<Player> TurnedPlayers { get; }
Property Value
Type Description
System.Collections.Generic.HashSet<Player>
| Improve this Doc View Source

Type

Declaration
public override RoleTypeId Type { get; }
Property Value
Type Description
PlayerRoles.RoleTypeId
Overrides

Methods

| Improve this Doc View Source

Blink(Vector3)

Teleport SCP-173 using the blink ability to the Target Position.

Declaration
public void Blink(Vector3 targetPos)
Parameters
Type Name Description
UnityEngine.Vector3 targetPos

The Target Position.
| Improve this Doc View Source

GetSpawnChance(List<RoleTypeId>)

Gets the Spawn Chance of SCP-173.

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.
| Improve this Doc View Source

PlaceTantrum(Boolean, Single)

Places a Tantrum (SCP-173's ability) under the player.

Declaration
public TantrumHazard PlaceTantrum(bool failIfObserved = false, float cooldown = 0F)
Parameters
Type Name Description
System.Boolean failIfObserved

Whether or not to place the tantrum if SCP-173 is currently being viewed.
System.Single cooldown

The cooldown until SCP-173 can place a tantrum again. Set to 0 to not affect the cooldown.
Returns
Type Description
TantrumHazard

The TantrumHazard instance, or null if it cannot be placed.
| Improve this Doc View Source

SendAudio(Scp173AudioPlayer.Scp173SoundId)

Plays a SCP-173 Audio Clip (Snap, Hit, Teleport).

Declaration
public void SendAudio(Scp173AudioPlayer.Scp173SoundId soundId)
Parameters
Type Name Description
PlayerRoles.PlayableScps.Scp173.Scp173AudioPlayer.Scp173SoundId soundId

The SoundId to Play.

Implements

Extension Methods