Table of Contents

Class Scp173Role

Namespace
Exiled.API.Features.Roles
Assembly
Exiled.API.dll

Defines a role that represents SCP-173.

public class Scp173Role : FpcRole, IWrapper<PlayerRoleBase>, IVoiceRole, ISubroutinedScpRole, IHumeShieldRole, ISpawnableScp
Inheritance
Scp173Role
Implements
IWrapper<PlayerRoleBase>
ISpawnableScp
Inherited Members
Extension Methods

Properties

AudioPlayer

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

public Scp173AudioPlayer AudioPlayer { get; }

Property Value

Scp173AudioPlayer

Base

Gets the PlayerRoles.PlayableScps.Scp173.Scp173Role instance.

public Scp173Role Base { get; }

Property Value

Scp173Role

BlinkCooldown

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

public float BlinkCooldown { get; set; }

Property Value

float

BlinkDistance

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

public float BlinkDistance { get; }

Property Value

float

BlinkReady

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

public bool BlinkReady { get; set; }

Property Value

bool

BlinkTimer

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

public Scp173BlinkTimer BlinkTimer { get; }

Property Value

Scp173BlinkTimer

BreakneckActive

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

public bool BreakneckActive { get; set; }

Property Value

bool

BreakneckSpeedsAbility

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

public Scp173BreakneckSpeedsAbility BreakneckSpeedsAbility { get; }

Property Value

Scp173BreakneckSpeedsAbility

HumeShieldModule

Gets a reference to the role's PlayerRoles.PlayableScps.HumeShield.HumeShieldModuleBase.

public HumeShieldModuleBase HumeShieldModule { get; }

Property Value

HumeShieldModuleBase

IsObserved

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

public bool IsObserved { get; }

Property Value

bool

MaxMovementSpeed

Gets SCP-173's max move speed.

public float MaxMovementSpeed { get; }

Property Value

float

MovementModule

Gets SCP-173's movement module.

public Scp173MovementModule MovementModule { get; }

Property Value

Scp173MovementModule

MovementSpeed

Gets the SCP-173's movement speed.

public override float MovementSpeed { get; }

Property Value

float

ObserversTracker

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

public Scp173ObserversTracker ObserversTracker { get; }

Property Value

Scp173ObserversTracker

ObservingPlayers

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

public IEnumerable<Player> ObservingPlayers { get; }

Property Value

IEnumerable<Player>

RemainingBreakneckCooldown

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

public float RemainingBreakneckCooldown { get; set; }

Property Value

float

RemainingTantrumCooldown

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

public float RemainingTantrumCooldown { get; set; }

Property Value

float

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.

public float SimulatedStare { get; set; }

Property Value

float

SubroutineModule

Gets the SCP PlayerRoles.Subroutines.SubroutineManagerModule.

public SubroutineManagerModule SubroutineModule { get; }

Property Value

SubroutineManagerModule

TantrumAbility

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

public Scp173TantrumAbility TantrumAbility { get; }

Property Value

Scp173TantrumAbility

TeleportAbility

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

public Scp173TeleportAbility TeleportAbility { get; }

Property Value

Scp173TeleportAbility

TurnedPlayers

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

public static HashSet<Player> TurnedPlayers { get; }

Property Value

HashSet<Player>

Type

Gets the PlayerRoles.RoleTypeId of this Player.

public override RoleTypeId Type { get; }

Property Value

RoleTypeId

Methods

Blink(Vector3)

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

public void Blink(Vector3 targetPos)

Parameters

targetPos Vector3

The Target Position.

GetSpawnChance(List<RoleTypeId>)

Gets the Spawn Chance of SCP-173.

public float GetSpawnChance(List<RoleTypeId> alreadySpawned)

Parameters

alreadySpawned List<RoleTypeId>

The List of Roles already spawned.

Returns

float

The Spawn Chance.

PlaceTantrum(bool, float)

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

public TantrumHazard PlaceTantrum(bool failIfObserved = false, float cooldown = 0)

Parameters

failIfObserved bool

Whether to place the tantrum if SCP-173 is currently being viewed.

cooldown float

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

Returns

TantrumHazard

The TantrumHazard instance, or null if it cannot be placed.

SendAudio(Scp173SoundId)

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

public void SendAudio(Scp173AudioPlayer.Scp173SoundId soundId)

Parameters

soundId Scp173AudioPlayer.Scp173SoundId

The SoundId to Play.

Edit this page