Class DoorComponent

Inheritance

System.Object

DoorComponent

Namespace: Content.Shared.Doors.Components

Assembly: Content.Shared.dll

Syntax

public sealed class DoorComponent : Component

Fields

AnimationKey

The key used when playing door opening/closing/emagging/deny animations.

Declaration

public const string AnimationKey = null

Field Value

Type	Description
System.String

BumpOpen

Whether the door will open when it is bumped into.

Declaration

public bool BumpOpen

Field Value

Type	Description
System.Boolean

CanCrush

If false, this door is incapable of crushing entities. This just determines whether it will apply damage and stun, not whether it can close despite entities being in the way.

Declaration

public bool CanCrush

Field Value

Type	Description
System.Boolean

CanPry

Declaration

public bool CanPry

Field Value

Type	Description
System.Boolean

ChangeAirtight

Declaration

public bool ChangeAirtight

Field Value

Type	Description
System.Boolean

ClickOpen

Whether the door will open when it is activated or clicked.

Declaration

public bool ClickOpen

Field Value

Type	Description
System.Boolean

ClosedDrawDepth

Declaration

public int ClosedDrawDepth

Field Value

Type	Description
System.Int32

ClosedSpriteState

The sprite state used for the door when it's closed.

Declaration

public string ClosedSpriteState

Field Value

Type	Description
System.String

ClosedSpriteStates

The sprite states used for the door while it's closed.

Declaration

public List<(DoorVisualLayers, string)> ClosedSpriteStates

Field Value

Type	Description
List<System.ValueTuple<DoorVisualLayers, System.String>>

CloseSound

Sound to play when the door closes.

Declaration

public SoundSpecifier CloseSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

CloseTimeOne

Closing time until impassable. Total time is this plus CloseTimeTwo.

Declaration

public TimeSpan CloseTimeOne

Field Value

Type	Description
TimeSpan

CloseTimeTwo

Closing time until fully closed. Total time is this plus CloseTimeOne.

Declaration

public TimeSpan CloseTimeTwo

Field Value

Type	Description
TimeSpan

ClosingAnimation

The animation used when the door closes.

Declaration

public object ClosingAnimation

Field Value

Type	Description
System.Object

ClosingAnimationTime

The sprite state used for the door when it's open.

Declaration

public float ClosingAnimationTime

Field Value

Type	Description
System.Single

ClosingSpriteState

The sprite state used for the door when it's closing.

Declaration

public string ClosingSpriteState

Field Value

Type	Description
System.String

CrushDamage

Declaration

public DamageSpecifier CrushDamage

Field Value

Type	Description
DamageSpecifier

CurrentlyCrushing

List of EntityUids of entities we're currently crushing. Cleared in OnPartialOpen().

Declaration

public HashSet<EntityUid> CurrentlyCrushing

Field Value

Type	Description
HashSet<EntityUid>

DenyDuration

Declaration

public TimeSpan DenyDuration

Field Value

Type	Description
TimeSpan

DenyingAnimation

The animation used when the door denies access.

Declaration

public object DenyingAnimation

Field Value

Type	Description
System.Object

DenySound

Sound to play if the door is denied.

Declaration

public SoundSpecifier DenySound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

DoorStunTime

This is how long a door-crush will stun you. This also determines how long it takes the door to open up again. Total stun time is actually given by this plus OpenTimeOne.

Declaration

public TimeSpan DoorStunTime

Field Value

Type	Description
TimeSpan

EmagDuration

Declaration

public TimeSpan EmagDuration

Field Value

Type	Description
TimeSpan

EmaggingAnimation

The animation used when the door is emagged.

Declaration

public object EmaggingAnimation

Field Value

Type	Description
System.Object

EmaggingAnimationTime

The sprite state used for the door when it's open.

Declaration

public float EmaggingAnimationTime

Field Value

Type	Description
System.Single

EmaggingSpriteState

The sprite state used for the door when it's being emagged.

Declaration

public string EmaggingSpriteState

Field Value

Type	Description
System.String

NextStateChange

When the door is active, this is the time when the state will next update.

Declaration

public TimeSpan? NextStateChange

Field Value

Type	Description
System.Nullable<TimeSpan>

Occludes

Whether the door blocks light.

Declaration

public bool Occludes

Field Value

Type	Description
System.Boolean

OpenDrawDepth

Declaration

public int OpenDrawDepth

Field Value

Type	Description
System.Int32

OpeningAnimation

The animation used when the door opens.

Declaration

public object OpeningAnimation

Field Value

Type	Description
System.Object

OpeningAnimationTime

The sprite state used for the door when it's open.

Declaration

public float OpeningAnimationTime

Field Value

Type	Description
System.Single

OpeningSpriteState

The sprite state used for the door when it's opening.

Declaration

public string OpeningSpriteState

Field Value

Type	Description
System.String

OpenSound

Sound to play when the door opens.

Declaration

public SoundSpecifier OpenSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

OpenSpriteState

The sprite state used for the door when it's open.

Declaration

public string OpenSpriteState

Field Value

Type	Description
System.String

OpenSpriteStates

The sprite states used for the door while it's open.

Declaration

public List<(DoorVisualLayers, string)> OpenSpriteStates

Field Value

Type	Description
List<System.ValueTuple<DoorVisualLayers, System.String>>

OpenTimeOne

Opening time until passable. Total time is this plus OpenTimeTwo.

Declaration

public TimeSpan OpenTimeOne

Field Value

Type	Description
TimeSpan

OpenTimeTwo

Opening time until fully open. Total time is this plus OpenTimeOne.

Declaration

public TimeSpan OpenTimeTwo

Field Value

Type	Description
TimeSpan

Partial

Whether the door is currently partially closed or open. I.e., when the door is "closing" and is already opaque, but not yet actually closed.

Declaration

public bool Partial

Field Value

Type	Description
System.Boolean

PerformCollisionCheck

Whether to check for colliding entities before closing. This may be overridden by other system by subscribing to BeforeDoorClosedEvent. For example, hacked airlocks will set this to false.

Declaration

public bool PerformCollisionCheck

Field Value

Type	Description
System.Boolean

PryingQuality

Declaration

public ProtoId<ToolQualityPrototype> PryingQuality

Field Value

Type	Description
Robust.Shared.Prototypes.ProtoId<ToolQualityPrototype>

PryTime

Default time that the door should take to pry open.

Declaration

public float PryTime

Field Value

Type	Description
System.Single

SparkSound

Sound to play when door has been emagged or possibly electrically tampered

Declaration

public SoundSpecifier SparkSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

State

The current state of the door -- whether it is open, closed, opening, or closing.

Declaration

public DoorState State

Field Value

Type	Description
DoorState

Remarks

This should never be set directly, use SetState(EntityUid, DoorState, DoorComponent) instead.

TryOpenDoorSound

Sound to play when a disarmed (hands comp with 0 hands) entity opens the door. What?

Declaration

public SoundSpecifier TryOpenDoorSound

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier