Show / Hide Table of Contents

Class SharedEntityStorageComponent

Inheritance
System.Object
SharedEntityStorageComponent
EntityStorageComponent
EntityStorageComponent
Namespace: Content.Shared.Storage.Components
Assembly: Content.Shared.dll
Syntax
public abstract class SharedEntityStorageComponent : Component

Fields

| Improve this Doc View Source

SharedEntityStorageComponent

Declaration
public Vector2
Field Value
Type Description
Vector2
| Improve this Doc View Source

Airtight

Whether or not the container is sealed and traps air inside of it

Declaration
public bool Airtight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Capacity

The total amount of items that can fit in one entitystorage

Declaration
public int Capacity
Field Value
Type Description
System.Int32
| Improve this Doc View Source

CloseSound

The sound made when closed

Declaration
public SoundSpecifier CloseSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier
| Improve this Doc View Source

Contents

The contents of the storage

Declaration
public Container Contents
Field Value
Type Description
Robust.Shared.Containers.Container
| Improve this Doc View Source

DeleteContentsOnDestruction

Whether or not all the contents stored should be deleted with the entitystorage

Declaration
public bool DeleteContentsOnDestruction
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

EnteringOffset

Declaration
public Vector2 EnteringOffset
Field Value
Type Description
Vector2
| Improve this Doc View Source

EnteringOffsetCollisionFlags

Declaration
public CollisionGroup EnteringOffsetCollisionFlags
Field Value
Type Description
CollisionGroup
| Improve this Doc View Source

EnteringRange

How close you have to be to the "entering" spot to be able to enter

Declaration
public float EnteringRange
Field Value
Type Description
System.Single
| Improve this Doc View Source

InternalOpenAttemptDelay

Declaration
public static readonly TimeSpan InternalOpenAttemptDelay
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

IsCollidableWhenOpen

Whether or not the entity still has collision when open

Declaration
public bool IsCollidableWhenOpen
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

LastInternalOpenAttempt

Declaration
public TimeSpan LastInternalOpenAttempt
Field Value
Type Description
TimeSpan
| Improve this Doc View Source

MasksToRemove

Collision masks that get removed when the storage gets opened.

Declaration
public readonly int MasksToRemove
Field Value
Type Description
System.Int32
| Improve this Doc View Source

MaxSize

Declaration
public readonly float MaxSize
Field Value
Type Description
System.Single
| Improve this Doc View Source

OccludesLight

Whether or not light is occluded by the storage

Declaration
public bool OccludesLight
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Open

Whether or not the entitystorage is open or closed

Declaration
public bool Open
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

OpenOnMove

If true, it opens the storage when the entity inside of it moves If false, it prevents the storage from opening when the entity inside of it moves. This is for objects that you want the player to move while inside, like large cardboard boxes, without opening the storage.

Declaration
public bool OpenOnMove
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

OpenSound

The sound made when open

Declaration
public SoundSpecifier OpenSound
Field Value
Type Description
Robust.Shared.Audio.SoundSpecifier
| Improve this Doc View Source

RemovedMasks

Collision masks that were removed from ANY layer when the storage was opened;

Declaration
public int RemovedMasks
Field Value
Type Description
System.Int32
| Improve this Doc View Source

ShowContents

Whether or not to show the contents when the storage is closed

Declaration
public bool ShowContents
Field Value
Type Description
System.Boolean
| Improve this Doc View Source

Whitelist

Whitelist for what entities are allowed to be inserted into this container. If this is not null, the standard requirement that the entity must be an item or mob is waived.

Declaration
public EntityWhitelist Whitelist
Field Value
Type Description
EntityWhitelist
  • Improve this Doc
  • View Source
☀
☾
In This Article
Back to top
Generated by DocFX
☀
☾