Class Scp079Role
Defines a role that represents SCP-079.
Inherited Members
Namespace: Exiled.API.Features.Roles
Assembly: Exiled.API.dll
Syntax
public class Scp079Role : Role, IWrapper<PlayerRoleBase>, ISubroutinedScpRole
Properties
| Improve this Doc View SourceAbilities
Gets or sets SCP-079's abilities. Can be null.
Declaration
public IScp079AuxRegenModifier[] Abilities { get; set; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.IScp079AuxRegenModifier[] |
AuxManager
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079AuxManager.
Declaration
public Scp079AuxManager AuxManager { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079AuxManager |
Base
Gets the game PlayerRoles.PlayableScps.Scp079.Scp079Role.
Declaration
public Scp079Role Base { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079Role |
BlackoutCapacity
Gets the maximum amount of rooms that SCP-079 can black out at its current Level.
Declaration
public int BlackoutCapacity { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
BlackoutCount
Gets the amount of rooms that SCP-079 has blacked out.
Declaration
public int BlackoutCount { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
BlackoutRoomAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079BlackoutRoomAbility.
Declaration
public Scp079BlackoutRoomAbility BlackoutRoomAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079BlackoutRoomAbility |
BlackoutZoneAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079BlackoutZoneAbility.
Declaration
public Scp079BlackoutZoneAbility BlackoutZoneAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079BlackoutZoneAbility |
BlackoutZoneCooldown
Gets or sets the amount of time until SCP-079 can use its blackout zone ability again.
Declaration
public float BlackoutZoneCooldown { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Camera
Gets or sets the camera SCP-079 is currently controlling.
Hcz079ContChamber
Camera if SCP-079's current camera cannot be detected.
Declaration
public Camera Camera { get; set; }
Property Value
Type | Description |
---|---|
Camera |
CameraPosition
Gets the Current Camera Position.
Declaration
public Vector3 CameraPosition { get; }
Property Value
Type | Description |
---|---|
UnityEngine.Vector3 |
CanTransmit
Gets a value indicating whether or not SCP-079 can transmit its voice to a speaker.
Declaration
public bool CanTransmit { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
CurrentCameraSync
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Cameras.Scp079CurrentCameraSync.
Declaration
public Scp079CurrentCameraSync CurrentCameraSync { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Cameras.Scp079CurrentCameraSync |
DoorLockChanger
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079DoorLockChanger.
Declaration
public Scp079DoorLockChanger DoorLockChanger { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079DoorLockChanger |
DoorStateChanger
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079DoorAbility.
Declaration
public Scp079DoorStateChanger DoorStateChanger { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079DoorStateChanger |
Energy
Gets or sets SCP-079's energy.
Declaration
public float Energy { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
EnergyRegenerationSpeed
Gets SCP-079's energy regeneration speed.
Declaration
public float EnergyRegenerationSpeed { get; }
Property Value
Type | Description |
---|---|
System.Single |
Experience
Gets or sets the amount of experience SCP-079 has.
Declaration
public int Experience { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
IsLost
Gets a value indicating whether or not SCP-079's signal is lost due to SCP-2176.
Declaration
public bool IsLost { get; }
Property Value
Type | Description |
---|---|
System.Boolean |
Level
Gets or sets SCP-079's level.
Declaration
public int Level { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
LevelIndex
Gets or sets SCP-079's level index.
Declaration
public int LevelIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
LockdownRoomAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079LockdownRoomAbility.
Declaration
public Scp079LockdownRoomAbility LockdownRoomAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079LockdownRoomAbility |
LockedDoor
Gets the doors SCP-079 has locked. Can be null.
Declaration
public Door LockedDoor { get; }
Property Value
Type | Description |
---|---|
Door |
LostSignalHandler
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079LostSignalHandler.
Declaration
public Scp079LostSignalHandler LostSignalHandler { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079LostSignalHandler |
LostTime
Gets a value indicating how much more time SCP-079 will be lost.
Declaration
public float LostTime { get; }
Property Value
Type | Description |
---|---|
System.Single |
MarkedRooms
Gets a list of rooms that have been marked by SCP-079. Marked rooms grant SCP-079 experience if a kill occurs in them.
Declaration
public IEnumerable<Room> MarkedRooms { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IEnumerable<Room> |
MaxEnergy
Gets or sets SCP-079's max energy.
Declaration
public float MaxEnergy { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
NextLevelThreshold
Gets SCP-079's next level threshold.
Declaration
public int NextLevelThreshold { get; }
Property Value
Type | Description |
---|---|
System.Int32 |
PingAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Pinging.Scp079PingAbility.
Declaration
public Scp079PingAbility PingAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Pinging.Scp079PingAbility |
RelativeExperience
Gets the relative experience.
Declaration
public float RelativeExperience { get; }
Property Value
Type | Description |
---|---|
System.Single |
RemainingLockdownDuration
Gets the Remaining Lockdown Duration.
Declaration
public float RemainingLockdownDuration { get; }
Property Value
Type | Description |
---|---|
System.Single |
RewardManager
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Rewards.Scp079RewardManager.
Declaration
public Scp079RewardManager RewardManager { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Rewards.Scp079RewardManager |
RollRotation
Gets the Roll Rotation of SCP-079.
Declaration
public float RollRotation { get; }
Property Value
Type | Description |
---|---|
System.Single |
RoomLockdownCooldown
Gets or sets SCP-079's room lockdown cooldown.
Declaration
public float RoomLockdownCooldown { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
ScannerTracker
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079ScannerTracker.
Declaration
public Scp079ScannerTracker ScannerTracker { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079ScannerTracker |
ScannerZoneSelector
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079ScannerZoneSelector.
Declaration
public Scp079ScannerZoneSelector ScannerZoneSelector { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079ScannerZoneSelector |
Scp2176LostTime
Gets or sets the amount of time that SCP-2176 will disable SCP-079 for.
Declaration
public float Scp2176LostTime { get; set; }
Property Value
Type | Description |
---|---|
System.Single |
Speaker
Gets the speaker SCP-079 is currently using. Can be null.
Declaration
public Scp079Speaker Speaker { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079Speaker |
SpeakerAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079SpeakerAbility.
Declaration
public Scp079SpeakerAbility SpeakerAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079SpeakerAbility |
SubroutineModule
Declaration
public SubroutineManagerModule SubroutineModule { get; }
Property Value
Type | Description |
---|---|
SubroutineManagerModule |
TeslaAbility
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079TeslaAbility.
Declaration
public Scp079TeslaAbility TeslaAbility { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079TeslaAbility |
TierManager
Gets SCP-079's PlayerRoles.PlayableScps.Scp079.Scp079TierManager.
Declaration
public Scp079TierManager TierManager { get; }
Property Value
Type | Description |
---|---|
PlayerRoles.PlayableScps.Scp079.Scp079TierManager |
TurnedPlayers
Gets a list of players who will be turned away from SCP-079's scan.
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 SourceActivateTesla(Boolean)
Trigger the SCP-079's Tesla Gate Ability.
Declaration
public void ActivateTesla(bool consumeEnergy = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | consumeEnergy | Indicates if the energy cost should be consume or not. |
AddExperience(Int32, Scp079HudTranslation)
Grants SCP-079 experience.
Declaration
public void AddExperience(int amount, Scp079HudTranslation reason = Scp079HudTranslation.ExpGainAdminCommand)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | amount | The amount to grant. |
PlayerRoles.PlayableScps.Scp079.Scp079HudTranslation | reason | The reason to grant experience. |
AddExperience(Int32, Scp079HudTranslation, RoleTypeId)
Grants SCP-079 experience.
Declaration
public void AddExperience(int amount, Scp079HudTranslation reason, RoleTypeId subject)
Parameters
Type | Name | Description |
---|---|---|
System.Int32 | amount | The amount to grant. |
PlayerRoles.PlayableScps.Scp079.Scp079HudTranslation | reason | The reason to grant experience. |
PlayerRoles.RoleTypeId | subject | The RoleType of the player that's causing it to happen. |
BlackoutRoom(Boolean)
Blackout the current room.
Declaration
public void BlackoutRoom(bool consumeEnergy = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | consumeEnergy | Indicates if the energy cost should be consumed or not. |
BlackoutZone(Boolean)
Blackout the current zone.
Declaration
public void BlackoutZone(bool consumeEnergy = true)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | consumeEnergy | Indicates if the energy cost should be consumed or not. |
CancelLockdown()
Cancels the Actual Lockdown.
Declaration
public void CancelLockdown()
ClearMarkedRooms()
Clears the list of marked SCP-079 rooms.
Declaration
public void ClearMarkedRooms()
GetCost(Door, DoorAction)
Gets the cost to modify a door.
Declaration
public int GetCost(Door door, DoorAction action)
Parameters
Type | Name | Description |
---|---|---|
Door | door | The door to get the cost to modify. |
Interactables.Interobjects.DoorUtils.DoorAction | action | The action. |
Returns
Type | Description |
---|---|
System.Int32 | The cost to modify the door. |
GetSpawnChance(List<RoleTypeId>)
Gets the spawn chance of SCP-079.
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. |
GetSwitchCost(Camera)
Gets the cost to switch from the current Camera to the provided camera
.
Declaration
public int GetSwitchCost(Camera camera)
Parameters
Type | Name | Description |
---|---|---|
Camera | camera | The camera to get the cost to switch to. |
Returns
Type | Description |
---|---|
System.Int32 | The cost to switch from the current camera to the new camera. |
LockDoor(Door)
Locks the provided door
.
Declaration
public bool LockDoor(Door door)
Parameters
Type | Name | Description |
---|---|---|
Door | door | The door to lock. |
Returns
Type | Description |
---|---|
System.Boolean | true if the door has been lock; otherwise, false. |
LockDoor(Door, Boolean)
Locks the provided door
.
Declaration
public bool LockDoor(Door door, bool consumeEnergy = true)
Parameters
Type | Name | Description |
---|---|---|
Door | door | The door to lock. |
System.Boolean | consumeEnergy | Indicates if the energy cost should be consumed or not. |
Returns
Type | Description |
---|---|
System.Boolean | true if the door has been lock; otherwise, false. |
LockdownRoom()
Trigger the Lockdown Room Ability to lock the current room.
Declaration
public void LockdownRoom()
LoseSignal(Single)
Forces SCP-079's signal to be lost for the specified amount of time.
Declaration
public void LoseSignal(float duration)
Parameters
Type | Name | Description |
---|---|---|
System.Single | duration | Time to lose SCP-079's signal. |
MarkRoom(Room)
Marks a room as being modified by SCP-079 (granting experience if a kill happens in the room).
Declaration
public void MarkRoom(Room room)
Parameters
Type | Name | Description |
---|---|---|
Room | room | The room to mark. |
MarkRooms(IEnumerable<Room>)
Marks a array of rooms as being modified by SCP-079 (granting experience if a kill happens in the room).
Declaration
public void MarkRooms(IEnumerable<Room> rooms)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.IEnumerable<Room> | rooms | The Array of Rooms to mark. |
Ping(Vector3, PingType, Boolean)
Trigger the Ping Ability to ping a RelativePositioning.RelativePosition.
Declaration
public void Ping(Vector3 position, PingType pingType = PingType.Default, bool consumeEnergy = true)
Parameters
Type | Name | Description |
---|---|---|
UnityEngine.Vector3 | position | The SyncNormal Position. |
PingType | pingType | The PingType to return. |
System.Boolean | consumeEnergy | Indicates if the energy cost should be consumed or not. |
UnlockAllDoors()
Unlocks all doors that SCP-079 has locked.
Declaration
public void UnlockAllDoors()
UnlockDoor()
Unlocks the LockedDoor.
Declaration
public void UnlockDoor()
UnlockDoor(Door)
Unlocks the provided door
.
Declaration
public void UnlockDoor(Door door)
Parameters
Type | Name | Description |
---|---|---|
Door | door | The door to unlock. |
UnmarkRoom(Room)
Removes a marked room.
Declaration
public void UnmarkRoom(Room room)
Parameters
Type | Name | Description |
---|---|---|
Room | room | The room to remove. |