Class SharedStorageSystem

Inheritance

System.Object

SharedStorageSystem

Namespace: Content.Shared.Storage.EntitySystems

Assembly: Content.Shared.dll

Syntax

public abstract class SharedStorageSystem : EntitySystem

Fields

| Improve this Doc View Source

_transform

Declaration

protected readonly SharedTransformSystem _transform

Field Value

Type	Description
SharedTransformSystem

| Improve this Doc View Source

Audio

Declaration

protected readonly SharedAudioSystem Audio

Field Value

Type	Description
SharedAudioSystem

| Improve this Doc View Source

EntityStorage

Declaration

protected readonly SharedEntityStorageSystem EntityStorage

Field Value

Type	Description
SharedEntityStorageSystem

| Improve this Doc View Source

Random

Declaration

protected readonly IRobustRandom Random

Field Value

Type	Description
Robust.Shared.Random.IRobustRandom

| Improve this Doc View Source

UseDelay

Declaration

protected readonly UseDelaySystem UseDelay

Field Value

Type	Description
UseDelaySystem

Methods

| Improve this Doc View Source

CanInsert(EntityUid, EntityUid, out Nullable<String>, StorageComponent)

Verifies if an entity can be stored and if it fits

Declaration

public bool CanInsert(EntityUid uid, EntityUid insertEnt, out string? reason, StorageComponent storageComp = null)

Parameters

Type	Name	Description
EntityUid	uid	The entity to check
EntityUid	insertEnt
System.Nullable<System.String>	reason	If returning false, the reason displayed to the player
StorageComponent	storageComp

Returns

Type	Description
System.Boolean	true if it can be inserted, false otherwise

| Improve this Doc View Source

GetAvailableSpace(EntityUid, StorageComponent)

Declaration

public int GetAvailableSpace(EntityUid uid, StorageComponent component = null)

Parameters

Type	Name	Description
EntityUid	uid
StorageComponent	component

Returns

Type	Description
System.Int32

| Improve this Doc View Source

Initialize()

Declaration

public override void Initialize()

| Improve this Doc View Source

Insert(EntityUid, EntityUid, out Nullable<EntityUid>, Nullable<EntityUid>, StorageComponent, Boolean)

Inserts into the storage container

Declaration

public bool Insert(EntityUid uid, EntityUid insertEnt, out EntityUid? stackedEntity, EntityUid? user = null, StorageComponent storageComp = null, bool playSound = true)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	insertEnt
System.Nullable<EntityUid>	stackedEntity
System.Nullable<EntityUid>	user
StorageComponent	storageComp
System.Boolean	playSound

Returns

Type	Description
System.Boolean	true if the entity was inserted, false otherwise

| Improve this Doc View Source

OpenStorageUI(EntityUid, EntityUid, StorageComponent, Boolean)

Declaration

public virtual void OpenStorageUI(EntityUid uid, EntityUid entity, StorageComponent storageComp = null, bool silent = false)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	entity
StorageComponent	storageComp
System.Boolean	silent

| Improve this Doc View Source

PlayerInsertEntityInWorld(EntityUid, EntityUid, EntityUid, StorageComponent)

Inserts an Entity (toInsert) in the world into storage, informing player if it fails. toInsert is NOT held, see .

Declaration

public bool PlayerInsertEntityInWorld(EntityUid uid, EntityUid player, EntityUid toInsert, StorageComponent storageComp = null)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	player	The player to insert an entity with
EntityUid	toInsert
StorageComponent	storageComp

Returns

Type	Description
System.Boolean	true if inserted, false otherwise

| Improve this Doc View Source

PlayerInsertHeldEntity(EntityUid, EntityUid, StorageComponent)

Inserts an entity into storage from the player's active hand

Declaration

public bool PlayerInsertHeldEntity(EntityUid uid, EntityUid player, StorageComponent storageComp = null)

Parameters

Type	Name	Description
EntityUid	uid
EntityUid	player	The player to insert an entity from
StorageComponent	storageComp

Returns

Type	Description
System.Boolean	true if inserted, false otherwise

| Improve this Doc View Source

PlayPickupAnimation(EntityUid, EntityCoordinates, EntityCoordinates, Angle, Nullable<EntityUid>)

Plays a clientside pickup animation for the specified uid.

Declaration

public abstract void PlayPickupAnimation(EntityUid uid, EntityCoordinates initialCoordinates, EntityCoordinates finalCoordinates, Angle initialRotation, EntityUid? user = null)

Parameters

Type	Name	Description
EntityUid	uid
Robust.Shared.Map.EntityCoordinates	initialCoordinates
Robust.Shared.Map.EntityCoordinates	finalCoordinates
Angle	initialRotation
System.Nullable<EntityUid>	user

| Improve this Doc View Source

RecalculateStorageUsed(EntityUid, StorageComponent)

Declaration

public void RecalculateStorageUsed(EntityUid uid, StorageComponent storageComp)

Parameters

Type	Name	Description
EntityUid	uid
StorageComponent	storageComp

| Improve this Doc View Source

TransferEntities(EntityUid, EntityUid, Nullable<EntityUid>, StorageComponent, LockComponent, StorageComponent, LockComponent)

Move entities from one storage to another.

Declaration

public void TransferEntities(EntityUid source, EntityUid target, EntityUid? user = null, StorageComponent sourceComp = null, LockComponent sourceLock = null, StorageComponent targetComp = null, LockComponent targetLock = null)

Parameters

Type	Name	Description
EntityUid	source
EntityUid	target
System.Nullable<EntityUid>	user
StorageComponent	sourceComp
LockComponent	sourceLock
StorageComponent	targetComp
LockComponent	targetLock

| Improve this Doc View Source

UpdateStorageVisualization(EntityUid, StorageComponent)

Declaration

protected void UpdateStorageVisualization(EntityUid uid, StorageComponent storageComp)

Parameters

Type	Name	Description
EntityUid	uid
StorageComponent	storageComp

| Improve this Doc View Source

UpdateUI(EntityUid, StorageComponent)

Declaration

public virtual void UpdateUI(EntityUid uid, StorageComponent component)

Parameters

Type	Name	Description
EntityUid	uid
StorageComponent	component