Doorclass
Constructors1
Showing 1 constructors
public Door()
No results match this filter.
Methods3
Showing 3 methods
public void Close()
Closes the door. Does nothing if already closed or closing.
void—public void Open(Sandbox.GameObject presser = null)
Opens the door. Does nothing if already open or opening.
| Parameter | Type | Description |
|---|---|---|
| presser = null | GameObject | — |
void—public void Toggle(Sandbox.GameObject presser = null)
Toggles the door between open and closed states.
| Parameter | Type | Description |
|---|---|---|
| presser = null | GameObject | — |
void—No results match this filter.
Properties30
Showing 30 properties
public Sandbox.Curve Sandbox.Mapping.Door.AnimationCurve { get; set; }
Animation curve to use, X is the time between 0-1 and Y is how much the door is open to its target angle from 0-1.
public bool Sandbox.Mapping.Door.AutoClose { get; set; }
Automatically close after opening.
bool—public float Sandbox.Mapping.Door.AutoCloseDelay { get; set; }
Delay before automatically closing (in seconds). -1 means stay open.
float—public Sandbox.SoundEvent Sandbox.Mapping.Door.CloseFinishedSound { get; set; }
Sound to play when a door has finished closing.
public Sandbox.SoundEvent Sandbox.Mapping.Door.CloseSound { get; set; }
Sound to play when a door is closed.
public string Sandbox.Mapping.Door.CloseTooltipDescription { get; set; }
string—public string Sandbox.Mapping.Door.CloseTooltipIcon { get; set; }
string—public string Sandbox.Mapping.Door.CloseTooltipTitle { get; set; }
string—public bool Sandbox.Mapping.Door.IsLocked { get; set; }
Is this door locked?
bool—public bool Sandbox.Mapping.Door.IsUsable { get; set; }
Can this door be opened by pressing it.
bool—public Sandbox.Mapping.Door Sandbox.Mapping.Door.LinkedDoor { get; set; }
Optional linked door that opens when this door opens. Useful for double doors.
public Sandbox.SoundEvent Sandbox.Mapping.Door.LockedSound { get; set; }
Sound to play when a door is interacted with while locked.
public string Sandbox.Mapping.Door.LockedTooltipDescription { get; set; }
string—public string Sandbox.Mapping.Door.LockedTooltipIcon { get; set; }
string—public string Sandbox.Mapping.Door.LockedTooltipTitle { get; set; }
string—public Sandbox.Mapping.Door.DoorMode Sandbox.Mapping.Door.Mode { get; set; }
Whether this door rotates or slides.
public Sandbox.Doo Sandbox.Mapping.Door.OnOpen { get; set; }
Called when the door is opened. Receives the GameObject that opened it.
public bool Sandbox.Mapping.Door.OpenAwayFromPlayer { get; set; }
Open away from the person who uses this door.
bool—public Sandbox.SoundEvent Sandbox.Mapping.Door.OpenFinishedSound { get; set; }
Sound to play when a door is fully opened.
public Sandbox.SoundEvent Sandbox.Mapping.Door.OpenSound { get; set; }
Sound to play when a door is opened.
public string Sandbox.Mapping.Door.OpenTooltipDescription { get; set; }
string—public string Sandbox.Mapping.Door.OpenTooltipIcon { get; set; }
string—public string Sandbox.Mapping.Door.OpenTooltipTitle { get; set; }
string—public Sandbox.GameObject Sandbox.Mapping.Door.Pivot { get; set; }
Optional pivot point, origin will be used if not specified.
public Vector3 Sandbox.Mapping.Door.SlideOffset { get; set; }
Local-space offset the door slides to when fully open.
public float Sandbox.Mapping.Door.Speed { get; set; }
Speed. Degrees per second for rotating, units per second for sliding.
float—public bool Sandbox.Mapping.Door.StartOpen { get; set; }
Start in the open position.
bool—public float Sandbox.Mapping.Door.TargetAngle { get; set; }
How far should the door rotate.
float—No results match this filter.