s&box docs

public abstract interface Sandbox.Component.IPressable

A component that can be pressed. Like a button. This could be by a player USE'ing it, or by a player walking on it, or by an NPC. A call to Press should ALWAYS call release afterwards. Generally this is done by the player, where holding E presses the button, and releasing E stops pressing it. You need to handle edge cases where the player dies while holding etc.

Broader workflow and conceptual references connected to this API.

Methods

Showing 8 methods

public virtual bool CanPress(Sandbox.Component.IPressable.Event e)

Return true if the press is possible right now

Implementations

public virtual System.Nullable`1<Sandbox.Component.IPressable.Tooltip> GetTooltip(Sandbox.Component.IPressable.Event e)

Get a tooltip to show when looking at this pressable

Implementations

public virtual bool Press(Sandbox.Component.IPressable.Event e)

Pressed. Returns true on success, else false. If it returns true then you should call Release when the press finishes. Not everything expects it, but some stuff will.

Implementations

public virtual bool Pressing(Sandbox.Component.IPressable.Event e)

Still being pressed. Return true to allow the press to continue, false cancel the press

Implementations

public virtual void Release(Sandbox.Component.IPressable.Event e)

To be called when the press finishes. You should only call this after a successful press - ie when Press hass returned true.

Implementations

Metadata

FieldValue
Namespaceglobal
Typeclass
AssemblySandbox.Engine
Doc IDT:Sandbox.Component.IPressable

On this page