Class SharedMaterialReclaimerSystem

Handles interactions and logic related to MaterialReclaimerComponent, CollideMaterialReclaimerComponent, and ActiveMaterialReclaimerComponent.

Inheritance
System.Object
SharedMaterialReclaimerSystem
MaterialReclaimerSystem
MaterialReclaimerSystem
Namespace: Content.Shared.Materials
Assembly: Content.Shared.dll
Syntax
public abstract class SharedMaterialReclaimerSystem : EntitySystem

Fields

| Improve this Doc View Source

ActiveReclaimerContainerId

Declaration
public const string ActiveReclaimerContainerId = null
Field Value
Type Description
System.String
| Improve this Doc View Source

AmbientSound

Declaration
protected readonly SharedAmbientSoundSystem AmbientSound
Field Value
Type Description
SharedAmbientSoundSystem
| Improve this Doc View Source

Timing

Declaration
protected readonly IGameTiming Timing
Field Value
Type Description
Robust.Shared.Timing.IGameTiming

Methods

| Improve this Doc View Source

CanGib(EntityUid, EntityUid, MaterialReclaimerComponent)

Whether or not the reclaimer satisfies the conditions allowing it to gib/reclaim a living creature.

Declaration
public bool CanGib(EntityUid uid, EntityUid victim, MaterialReclaimerComponent component)
Parameters
Type Name Description
EntityUid uid
EntityUid victim
MaterialReclaimerComponent component
Returns
Type Description
System.Boolean
| Improve this Doc View Source

CanStart(EntityUid, MaterialReclaimerComponent)

Whether or not the specified reclaimer can currently begin reclaiming another entity.

Declaration
public bool CanStart(EntityUid uid, MaterialReclaimerComponent component)
Parameters
Type Name Description
EntityUid uid
MaterialReclaimerComponent component
Returns
Type Description
System.Boolean
| Improve this Doc View Source

GetReclaimingDuration(EntityUid, EntityUid, MaterialReclaimerComponent, PhysicalCompositionComponent)

Gets the duration of processing a specified entity. Processing is calculated from the sum of the materials within the entity. It does not regard the chemicals within it.

Declaration
public TimeSpan GetReclaimingDuration(EntityUid reclaimer, EntityUid item, MaterialReclaimerComponent reclaimerComponent = null, PhysicalCompositionComponent compositionComponent = null)
Parameters
Type Name Description
EntityUid reclaimer
EntityUid item
MaterialReclaimerComponent reclaimerComponent
PhysicalCompositionComponent compositionComponent
Returns
Type Description
TimeSpan
| Improve this Doc View Source

Initialize()

Declaration
public override void Initialize()
| Improve this Doc View Source

Reclaim(EntityUid, EntityUid, Single, MaterialReclaimerComponent)

Spawns the materials and chemicals associated with an entity. Also deletes the item.

Declaration
public virtual void Reclaim(EntityUid uid, EntityUid item, float completion = 1F, MaterialReclaimerComponent component = null)
Parameters
Type Name Description
EntityUid uid
EntityUid item
System.Single completion
MaterialReclaimerComponent component
| Improve this Doc View Source

SetReclaimerEnabled(EntityUid, Boolean, MaterialReclaimerComponent)

Sets the Enabled field on the reclaimer.

Declaration
public void SetReclaimerEnabled(EntityUid uid, bool enabled, MaterialReclaimerComponent component = null)
Parameters
Type Name Description
EntityUid uid
System.Boolean enabled
MaterialReclaimerComponent component
| Improve this Doc View Source

TryFinishProcessItem(EntityUid, MaterialReclaimerComponent, ActiveMaterialReclaimerComponent)

Finishes processing an item, freeing up the the reclaimer.

Declaration
public virtual bool TryFinishProcessItem(EntityUid uid, MaterialReclaimerComponent component = null, ActiveMaterialReclaimerComponent active = null)
Parameters
Type Name Description
EntityUid uid
MaterialReclaimerComponent component
ActiveMaterialReclaimerComponent active
Returns
Type Description
System.Boolean
Remarks

This doesn't reclaim the entity itself, but rather ends the formal process started with ActiveMaterialReclaimerComponent. The actual reclaiming happens in Reclaim(EntityUid, EntityUid, Single, MaterialReclaimerComponent)

| Improve this Doc View Source

TryStartProcessItem(EntityUid, EntityUid, MaterialReclaimerComponent, Nullable<EntityUid>)

Tries to start processing an item via a MaterialReclaimerComponent.

Declaration
public bool TryStartProcessItem(EntityUid uid, EntityUid item, MaterialReclaimerComponent component = null, EntityUid? user = null)
Parameters
Type Name Description
EntityUid uid
EntityUid item
MaterialReclaimerComponent component
System.Nullable<EntityUid> user
Returns
Type Description
System.Boolean
| Improve this Doc View Source

Update(Single)

Declaration
public override void Update(float frameTime)
Parameters
Type Name Description
System.Single frameTime