Class MyResourceDistributorComponent

Inheritance

System.Object

MyComponentBase

MyEntityComponentBase

MyResourceDistributorComponent

Implements

IMyResourceDistributorComponent

Inherited Members

MyEntityComponentBase.OnAddedToContainer()

MyEntityComponentBase.OnBeforeRemovedFromContainer()

MyEntityComponentBase.Container

MyEntityComponentBase.Entity

MyEntityComponentBase.AttachSyncToEntity

MyEntityComponentBase.OnAfterAddedToContainer

MyEntityComponentBase.BeforeRemovedFromContainer

MyComponentBase.SetContainer(IMyComponentContainer)

MyComponentBase.GetAs<T>()

MyComponentBase.OnAddedToScene()

MyComponentBase.OnRemovedFromScene()

MyComponentBase.Serialize(Boolean)

MyComponentBase.Deserialize(MyObjectBuilder_ComponentBase)

MyComponentBase.Init(MyComponentDefinitionBase)

MyComponentBase.IsSerialized()

MyComponentBase.RemoveExistingComponentOnNewInsert

MyComponentBase.ContainerBase

Namespace: Sandbox.Game.EntityComponents

Assembly: Sandbox.Game.dll

Syntax

public class MyResourceDistributorComponent : MyEntityComponentBase, IMyEntityComponentBase, IMyComponentBase, IMyResourceDistributorComponent

Constructors

MyResourceDistributorComponent(String)

Declaration

public MyResourceDistributorComponent(string debugName)

Parameters

Type	Name	Description
System.String	debugName

Fields

DebugName

Declaration

public string DebugName

Field Value

Type	Description
System.String

ElectricityId

Declaration

public static readonly MyDefinitionId ElectricityId

Field Value

Type	Description
MyDefinitionId

HydrogenId

Declaration

public static readonly MyDefinitionId HydrogenId

Field Value

Type	Description
MyDefinitionId

m_initializedTypes

Declaration

protected readonly HashSet<MyDefinitionId> m_initializedTypes

Field Value

Type	Description
System.Collections.Generic.HashSet<MyDefinitionId>

OxygenId

Declaration

public static readonly MyDefinitionId OxygenId

Field Value

Type	Description
MyDefinitionId

ShowTrace

For debugging purposes. Enables trace messages and watches for this instance.

Declaration

public static bool ShowTrace

Field Value

Type	Description
System.Boolean

Properties

ComponentTypeDebugString

Declaration

public override string ComponentTypeDebugString { get; }

Property Value

Type	Description
System.String

Overrides

MyEntityComponentBase.ComponentTypeDebugString

ResourceState

Declaration

public MyResourceStateEnum ResourceState { get; }

Property Value

Type	Description
VRage.MyResourceStateEnum

SinkGroupPrioritiesTotal

Declaration

public static int SinkGroupPrioritiesTotal { get; }

Property Value

Type	Description
System.Int32

SinkSubtypesToPriority

Declaration

public static DictionaryReader<MyStringHash, int> SinkSubtypesToPriority { get; }

Property Value

Type	Description
DictionaryReader<MyStringHash, System.Int32>

SourcesEnabled

Declaration

public MyMultipleEnabledEnum SourcesEnabled { get; }

Property Value

Type	Description
VRage.MyMultipleEnabledEnum

Methods

AddSink(MyResourceSinkComponent)

Declaration

public void AddSink(MyResourceSinkComponent sink)

Parameters

Type	Name	Description
MyResourceSinkComponent	sink

AddSource(MyResourceSourceComponent)

Declaration

public void AddSource(MyResourceSourceComponent source)

Parameters

Type	Name	Description
MyResourceSourceComponent	source

ChangeSourcesState(MyDefinitionId, MyMultipleEnabledEnum, Int64, MyCubeGrid)

Declaration

public void ChangeSourcesState(MyDefinitionId resourceTypeId, MyMultipleEnabledEnum state, long playerId, MyCubeGrid onlyForThisGrid = null)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
VRage.MyMultipleEnabledEnum	state
System.Int64	playerId
MyCubeGrid	onlyForThisGrid

Clear()

Declaration

public static void Clear()

ClearData()

Declaration

public void ClearData()

ConveyorSystem_OnPoweredChanged()

Declaration

public void ConveyorSystem_OnPoweredChanged()

DebugDraw(MyEntity)

Declaration

public void DebugDraw(MyEntity entity)

Parameters

Type	Name	Description
MyEntity	entity

GetElectricalGridsGroups()

Declaration

public List<List<long>> GetElectricalGridsGroups()

Returns

Type	Description
System.Collections.Generic.List<System.Collections.Generic.List<System.Int64>>

GetElectricalGroupIndex(ref MyDefinitionId, MyCubeGrid)

Declaration

public int GetElectricalGroupIndex(ref MyDefinitionId typeId, MyCubeGrid grid)

Parameters

Type	Name	Description
MyDefinitionId	typeId
MyCubeGrid	grid

Returns

Type	Description
System.Int32

GetSourceCount(MyDefinitionId, MyStringHash)

Declaration

public int GetSourceCount(MyDefinitionId resourceTypeId, MyStringHash sourceGroupType)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
MyStringHash	sourceGroupType

Returns

Type	Description
System.Int32

IsConveyorConnectionRequiredTotal(MyDefinitionId)

Declaration

public static bool IsConveyorConnectionRequiredTotal(MyDefinitionId typeId)

Parameters

Type	Name	Description
MyDefinitionId	typeId

Returns

Type	Description
System.Boolean

IsConveyorConnectionRequiredTotal(ref MyDefinitionId)

Declaration

public static bool IsConveyorConnectionRequiredTotal(ref MyDefinitionId typeId)

Parameters

Type	Name	Description
MyDefinitionId	typeId

Returns

Type	Description
System.Boolean

MarkConveyoredResourcesDirty()

Declaration

public void MarkConveyoredResourcesDirty()

MarkForUpdate()

Declaration

public void MarkForUpdate()

MaxAvailableResourceByType(MyDefinitionId, MyCubeGrid)

Declaration

public float MaxAvailableResourceByType(MyDefinitionId resourceTypeId, MyCubeGrid grid = null)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
MyCubeGrid	grid

Returns

Type	Description
System.Single

MaxAvailableResourceByType(MyDefinitionId, IMyCubeGrid)

Declaration

public float MaxAvailableResourceByType(MyDefinitionId resourceTypeId, IMyCubeGrid grid)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
IMyCubeGrid	grid

Returns

Type	Description
System.Single

PowerStateIsOk(MyResourceStateEnum)

Declaration

protected bool PowerStateIsOk(MyResourceStateEnum state)

Parameters

Type	Name	Description
VRage.MyResourceStateEnum	state

Returns

Type	Description
System.Boolean

PowerStateWorks(MyResourceStateEnum)

Declaration

protected bool PowerStateWorks(MyResourceStateEnum state)

Parameters

Type	Name	Description
VRage.MyResourceStateEnum	state

Returns

Type	Description
System.Boolean

RecomputeResourceDistribution(ref MyDefinitionId, Boolean)

Declaration

public void RecomputeResourceDistribution(ref MyDefinitionId typeId, bool updateChanges = true)

Parameters

Type	Name	Description
MyDefinitionId	typeId
System.Boolean	updateChanges

RemainingFuelTimeByType(MyDefinitionId, MyCubeGrid)

Specify grid when asking for electricity.

Declaration

public float RemainingFuelTimeByType(MyDefinitionId resourceTypeId, MyCubeGrid grid = null)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
MyCubeGrid	grid

Returns

Type	Description
System.Single

RemoveSink(MyResourceSinkComponent, Boolean, Boolean)

Declaration

public void RemoveSink(MyResourceSinkComponent sink, bool resetSinkInput = true, bool markedForClose = false)

Parameters

Type	Name	Description
MyResourceSinkComponent	sink
System.Boolean	resetSinkInput
System.Boolean	markedForClose

RemoveSource(MyResourceSourceComponent)

Declaration

public void RemoveSource(MyResourceSourceComponent source)

Parameters

Type	Name	Description
MyResourceSourceComponent	source

ResourceStateByType(MyDefinitionId, Boolean, MyCubeGrid)

Specify grid when asking for electricity. Electricity is shared only between certain grids.

Declaration

public MyResourceStateEnum ResourceStateByType(MyDefinitionId typeId, bool withRecompute = true, MyCubeGrid grid = null)

Parameters

Type	Name	Description
MyDefinitionId	typeId
System.Boolean	withRecompute
MyCubeGrid	grid

Returns

Type	Description
VRage.MyResourceStateEnum

SetDataDirty(MyDefinitionId)

Declaration

public void SetDataDirty(MyDefinitionId typeId)

Parameters

Type	Name	Description
MyDefinitionId	typeId

SetNeedRecompute(MyDefinitionId)

Declaration

public void SetNeedRecompute(MyDefinitionId typeId)

Parameters

Type	Name	Description
MyDefinitionId	typeId

SetNeedRecomputeAll()

Declaration

public void SetNeedRecomputeAll()

SourcesEnabledByType(MyDefinitionId)

Declaration

public MyMultipleEnabledEnum SourcesEnabledByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
VRage.MyMultipleEnabledEnum

TotalRequiredInputByType(MyDefinitionId, MyCubeGrid)

Declaration

public float TotalRequiredInputByType(MyDefinitionId resourceTypeId, MyCubeGrid grid = null)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
MyCubeGrid	grid

Returns

Type	Description
System.Single

TotalRequiredInputByType(MyDefinitionId, IMyCubeGrid)

Declaration

public float TotalRequiredInputByType(MyDefinitionId resourceTypeId, IMyCubeGrid grid)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
IMyCubeGrid	grid

Returns

Type	Description
System.Single

UpdateBeforeSimulation()

Declaration

public void UpdateBeforeSimulation()

UpdateBeforeSimulation100()

Declaration

public virtual void UpdateBeforeSimulation100()

UpdateHud(MyHudSinkGroupInfo)

Computes number of groups that have enough energy to work.

Declaration

public void UpdateHud(MyHudSinkGroupInfo info)

Parameters

Type	Name	Description
Sandbox.Game.Gui.MyHudSinkGroupInfo	info

Events

OnPowerGenerationChanged

Declaration

public event Action<bool> OnPowerGenerationChanged

Event Type

Type	Description
System.Action<System.Boolean>

SystemChanged

Event raised when any element of this system is changed, requiring the system to update.

Declaration

public event Action SystemChanged

Event Type

Type	Description
System.Action

Implements

IMyResourceDistributorComponent

Extension Methods

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)

MyEntityContainerEventExtensions.RegisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash, MyEntityContainerEventExtensions.EntityEventHandler)

MyEntityContainerEventExtensions.UnregisterForEntityEvent(MyEntityComponentBase, MyEntity, MyStringHash)

MyEntityContainerEventExtensions.RaiseEntityEvent(MyEntityComponentBase, MyStringHash, MyEntityContainerEventExtensions.EntityEventParams)