Class VendingMachineComponent

Inheritance

System.Object

VendingMachineComponent

Namespace: Content.Shared.VendingMachines

Assembly: Content.Shared.dll

Syntax

public sealed class VendingMachineComponent : Component

Fields

Action

The action available to the player controlling the vending machine

Declaration

public string? Action

Field Value

Type	Description
System.Nullable<System.String>

ActionEntity

Declaration

public EntityUid? ActionEntity

Field Value

Type	Description
System.Nullable<EntityUid>

Broken

Declaration

public bool Broken

Field Value

Type	Description
System.Boolean

BrokenState

RSI state for when the vending machine is unpowered. Will be displayed on the layer Base

Declaration

public string? BrokenState

Field Value

Type	Description
System.Nullable<System.String>

CanShoot

When true, will forcefully throw any object it dispenses

Declaration

public bool CanShoot

Field Value

Type	Description
System.Boolean

Contraband

Declaration

public bool Contraband

Field Value

Type	Description
System.Boolean

ContrabandInventory

Declaration

public Dictionary<string, VendingMachineInventoryEntry> ContrabandInventory

Field Value

Type	Description
Dictionary<System.String, VendingMachineInventoryEntry>

DenyAccumulator

Declaration

public float DenyAccumulator

Field Value

Type	Description
System.Single

DenyDelay

Used by the server to determine how long the vending machine stays in the "Deny" state. Used by the client to determine how long the deny animation should be played.

Declaration

public float DenyDelay

Field Value

Type	Description
System.Single

Denying

Declaration

public bool Denying

Field Value

Type	Description
System.Boolean

DenyState

RSI state for the vending machine's deny animation. Will either be played once as sprite flick or looped depending on how LoopDenyAnimation is set. Will be displayed on the layer BaseUnshaded

Declaration

public string? DenyState

Field Value

Type	Description
System.Nullable<System.String>

DispenseOnHitAccumulator

Declaration

public float DispenseOnHitAccumulator

Field Value

Type	Description
System.Single

DispenseOnHitChance

The chance that a vending machine will randomly dispense an item on hit. Chance is 0 if null.

Declaration

public float? DispenseOnHitChance

Field Value

Type	Description
System.Nullable<System.Single>

DispenseOnHitCooldown

Amount of time in seconds that need to pass before damage can cause a vending machine to eject again. This value is separate to EjectDelay because that value might be 0 for a vending machine for legitimate reasons (no desired delay/no eject animation) and can be circumvented with forced ejections.

Declaration

public float? DispenseOnHitCooldown

Field Value

Type	Description
System.Nullable<System.Single>

DispenseOnHitCoolingDown

Declaration

public bool DispenseOnHitCoolingDown

Field Value

Type	Description
System.Boolean

DispenseOnHitThreshold

The minimum amount of damage that must be done per hit to have a chance of dispensing an item.

Declaration

public float? DispenseOnHitThreshold

Field Value

Type	Description
System.Nullable<System.Single>

EjectAccumulator

Declaration

public float EjectAccumulator

Field Value

Type	Description
System.Single

EjectDelay

Used by the server to determine how long the vending machine stays in the "Eject" state. The selected item is dispensed afer this delay. Used by the client to determine how long the deny animation should be played.

Declaration

public float EjectDelay

Field Value

Type	Description
System.Single

Ejecting

Declaration

public bool Ejecting

Field Value

Type	Description
System.Boolean

EjectState

RSI state for the vending machine's eject animation. Will be displayed on the layer BaseUnshaded

Declaration

public string? EjectState

Field Value

Type	Description
System.Nullable<System.String>

EmaggedInventory

Declaration

public Dictionary<string, VendingMachineInventoryEntry> EmaggedInventory

Field Value

Type	Description
Dictionary<System.String, VendingMachineInventoryEntry>

Inventory

Declaration

public Dictionary<string, VendingMachineInventoryEntry> Inventory

Field Value

Type	Description
Dictionary<System.String, VendingMachineInventoryEntry>

LoopDenyAnimation

If set to true (default) will loop the animation of the DenyState for the duration of DenyDelay. If set to false will play a sprite flick animation for the state and then linger on the final frame until the end of the delay.

Declaration

public bool LoopDenyAnimation

Field Value

Type	Description
System.Boolean

NextEmpEject

While disabled by EMP it randomly ejects items

Declaration

public TimeSpan NextEmpEject

Field Value

Type	Description
TimeSpan

NextItemToEject

Declaration

public string? NextItemToEject

Field Value

Type	Description
System.Nullable<System.String>

NonLimitedEjectForce

Declaration

public float NonLimitedEjectForce

Field Value

Type	Description
System.Single

NonLimitedEjectRange

Declaration

public float NonLimitedEjectRange

Field Value

Type	Description
System.Single

NormalState

RSI state for the vending machine's normal state. Usually a looping animation. Will be displayed on the layer BaseUnshaded

Declaration

public string? NormalState

Field Value

Type	Description
System.Nullable<System.String>

OffState

RSI state for when the vending machine is unpowered. Will be displayed on the layer Base

Declaration

public string? OffState

Field Value

Type	Description
System.Nullable<System.String>

PackPrototypeId

PrototypeID for the vending machine's inventory, see VendingMachineInventoryPrototype

Declaration

public string PackPrototypeId

Field Value

Type	Description
System.String

ScreenState

RSI state for the screen of the vending machine Will be displayed on the layer Screen

Declaration

public string? ScreenState

Field Value

Type	Description
System.Nullable<System.String>

SoundDeny

Sound that plays when an item can't be ejected

Declaration

public SoundSpecifier SoundDeny

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

SoundVend

Sound that plays when ejecting an item

Declaration

public SoundSpecifier SoundVend

Field Value

Type	Description
Robust.Shared.Audio.SoundSpecifier

ThrowNextItem

Declaration

public bool ThrowNextItem

Field Value

Type	Description
System.Boolean