Class MyResourceSinkComponentBase

Inheritance

System.Object

MyComponentBase

MyEntityComponentBase

MyResourceSinkComponentBase

MyResourceSinkComponent

Inherited Members

MyEntityComponentBase.OnAddedToContainer()

MyEntityComponentBase.OnBeforeRemovedFromContainer()

MyEntityComponentBase.Container

MyEntityComponentBase.Entity

MyEntityComponentBase.ComponentTypeDebugString

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: VRage.Game.Components

Assembly: VRage.Game.dll

Syntax

public abstract class MyResourceSinkComponentBase : MyEntityComponentBase, IMyEntityComponentBase, IMyComponentBase, IMyResourceSinkComponent

Constructors

MyResourceSinkComponentBase()

Declaration

protected MyResourceSinkComponentBase()

Properties

AcceptedResources

Declaration

public abstract ListReader<MyDefinitionId> AcceptedResources { get; }

Property Value

Type	Description
ListReader<MyDefinitionId>

TemporaryConnectedEntity

Declaration

public abstract IMyEntity TemporaryConnectedEntity { get; set; }

Property Value

Type	Description
IMyEntity

Methods

CurrentInputByType(MyDefinitionId)

Declaration

public abstract float CurrentInputByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
System.Single

IsPowerAvailable(MyDefinitionId, Single)

Declaration

public abstract bool IsPowerAvailable(MyDefinitionId resourceTypeId, float power)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
System.Single	power

Returns

Type	Description
System.Boolean

IsPoweredByType(MyDefinitionId)

Declaration

public abstract bool IsPoweredByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
System.Boolean

MaxRequiredInputByType(MyDefinitionId)

Declaration

public abstract float MaxRequiredInputByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
System.Single

RequiredInputByType(MyDefinitionId)

Declaration

public abstract float RequiredInputByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
System.Single

SetInputFromDistributor(MyDefinitionId, Single, Boolean, Boolean)

Declaration

public abstract void SetInputFromDistributor(MyDefinitionId resourceTypeId, float newResourceInput, bool isAdaptible, bool fireEvents = true)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
System.Single	newResourceInput
System.Boolean	isAdaptible
System.Boolean	fireEvents

SetMaxRequiredInputByType(MyDefinitionId, Single)

Declaration

public abstract void SetMaxRequiredInputByType(MyDefinitionId resourceTypeId, float newMaxRequiredInput)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
System.Single	newMaxRequiredInput

SetRequiredInputByType(MyDefinitionId, Single)

Declaration

public abstract void SetRequiredInputByType(MyDefinitionId resourceTypeId, float newRequiredInput)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
System.Single	newRequiredInput

SetRequiredInputFuncByType(MyDefinitionId, Func<Single>)

Declaration

public abstract Func<float> SetRequiredInputFuncByType(MyDefinitionId resourceTypeId, Func<float> newRequiredInputFunc)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId
System.Func<System.Single>	newRequiredInputFunc

Returns

Type	Description
System.Func<System.Single>

SuppliedRatioByType(MyDefinitionId)

Declaration

public abstract float SuppliedRatioByType(MyDefinitionId resourceTypeId)

Parameters

Type	Name	Description
MyDefinitionId	resourceTypeId

Returns

Type	Description
System.Single

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)