Table of Contents

Class ResourceContainerGroupSequence

Namespace
KSP.Sim.ResourceSystem
Assembly
Assembly-CSharp.dll
public class ResourceContainerGroupSequence : IResourceContainer, IResourceContainerReadOnly, IReadOnlyCollection<ResourceDefinitionID>, IEnumerable<ResourceDefinitionID>, IEnumerable
Inheritance
ResourceContainerGroupSequence
Implements
Inherited Members
Extension Methods

Constructors

ResourceContainerGroupSequence()

public ResourceContainerGroupSequence()

ResourceContainerGroupSequence(params ResourceContainerGroup[])

public ResourceContainerGroupSequence(params ResourceContainerGroup[] groupsInSequence)

Parameters

groupsInSequence ResourceContainerGroup[]

ResourceContainerGroupSequence(IEnumerable<ResourceContainerGroup>)

public ResourceContainerGroupSequence(IEnumerable<ResourceContainerGroup> groupsInSequence)

Parameters

groupsInSequence IEnumerable<ResourceContainerGroup>

Properties

AreDefinitionsFrozen

public bool AreDefinitionsFrozen { get; }

Property Value

bool

Count

public int Count { get; }

Property Value

int

GroupCount

public int GroupCount { get; }

Property Value

int

GroupsInSequence

public IReadOnlyList<ResourceContainerGroup> GroupsInSequence { get; }

Property Value

IReadOnlyList<ResourceContainerGroup>

Methods

AddGroup(ResourceContainerGroup)

public void AddGroup(ResourceContainerGroup group)

Parameters

group ResourceContainerGroup

AddResourceUnits(ResourceDefinitionID, double)

public double AddResourceUnits(ResourceDefinitionID resourceID, double totalUnitsToAdd)

Parameters

resourceID ResourceDefinitionID
totalUnitsToAdd double

Returns

double

AddResourceUnits(ResourceDefinitionID, double, double)

public double AddResourceUnits(ResourceDefinitionID resourceID, double unitsToAddPerSecond, double timeInSeconds)

Parameters

resourceID ResourceDefinitionID
unitsToAddPerSecond double
timeInSeconds double

Returns

double

ClearGroups()

public void ClearGroups()

ConsumePreProcessedResourceUnits(ResourceDefinitionID, double)

public double ConsumePreProcessedResourceUnits(ResourceDefinitionID resourceID, double totalUnitsToConsume)

Parameters

resourceID ResourceDefinitionID
totalUnitsToConsume double

Returns

double

DumpAllResources()

public void DumpAllResources()

DumpResource(ResourceDefinitionID)

public double DumpResource(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

FillAllResourcesToCapacity()

public void FillAllResourcesToCapacity()

FillResourceToCapacity(ResourceDefinitionID)

public double FillResourceToCapacity(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetAllResourcesContained(ref ICollection<ResourceDefinitionID>, bool)

public void GetAllResourcesContained(ref ICollection<ResourceDefinitionID> containedResources, bool clear = true)

Parameters

containedResources ICollection<ResourceDefinitionID>
clear bool

GetAllResourcesContainedData()

public IEnumerable<ContainedResourceData> GetAllResourcesContainedData()

Returns

IEnumerable<ContainedResourceData>

GetEnumerator()

public IEnumerator<ResourceDefinitionID> GetEnumerator()

Returns

IEnumerator<ResourceDefinitionID>

GetResourceCapacityUnits(ResourceDefinitionID)

public double GetResourceCapacityUnits(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetResourceContainedData(ResourceDefinitionID)

public ContainedResourceData GetResourceContainedData(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

ContainedResourceData

GetResourceEmptyUnits(ResourceDefinitionID)

public double GetResourceEmptyUnits(ResourceDefinitionID resourceId)

Parameters

resourceId ResourceDefinitionID

Returns

double

GetResourceFillRatio(ResourceDefinitionID)

public double GetResourceFillRatio(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetResourcePreProcessedUnits(ResourceDefinitionID)

public double GetResourcePreProcessedUnits(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetResourceStoredMass(ResourceDefinitionID)

public double GetResourceStoredMass(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetResourceStoredUnits(ResourceDefinitionID)

public double GetResourceStoredUnits(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetResourceStoredUnits(ResourceDefinitionID, bool)

public double GetResourceStoredUnits(ResourceDefinitionID resourceID, bool includePreProcessed)

Parameters

resourceID ResourceDefinitionID
includePreProcessed bool

Returns

double

GetResourcesContainedCount()

public int GetResourcesContainedCount()

Returns

int

GetStoredResourceThermalMass(ResourceDefinitionID)

public double GetStoredResourceThermalMass(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

double

GetStoredResourcesTotalMass()

public double GetStoredResourcesTotalMass()

Returns

double

GetStoredResourcesTotalThermalMass()

public double GetStoredResourcesTotalThermalMass()

Returns

double

IsResourceContained(ResourceDefinitionID)

public bool IsResourceContained(ResourceDefinitionID resourceID)

Parameters

resourceID ResourceDefinitionID

Returns

bool

OverrideContainedCapacity(ResourceDefinitionID, double, bool, bool)

public bool OverrideContainedCapacity(ResourceDefinitionID resourceID, double capacityUnits, bool nonStageable, bool fillToCapacity = false)

Parameters

resourceID ResourceDefinitionID
capacityUnits double
nonStageable bool
fillToCapacity bool

Returns

bool

OverrideContainedData(ContainedResourceData)

public bool OverrideContainedData(ContainedResourceData data)

Parameters

data ContainedResourceData

Returns

bool

OverrideContainedData(ResourceDefinitionID, double, double, bool)

public bool OverrideContainedData(ResourceDefinitionID resourceID, double capacityUnits, double storedUnits, bool nonStageable)

Parameters

resourceID ResourceDefinitionID
capacityUnits double
storedUnits double
nonStageable bool

Returns

bool

RemoveResourceUnits(ResourceDefinitionID, double)

public double RemoveResourceUnits(ResourceDefinitionID resourceID, double totalUnitsToRemove)

Parameters

resourceID ResourceDefinitionID
totalUnitsToRemove double

Returns

double

RemoveResourceUnits(ResourceDefinitionID, double, double)

public double RemoveResourceUnits(ResourceDefinitionID resourceID, double unitsToRemovePerSecond, double timeInSeconds)

Parameters

resourceID ResourceDefinitionID
unitsToRemovePerSecond double
timeInSeconds double

Returns

double

ResetPreProcessedResources()

public void ResetPreProcessedResources()

SetGroups(params ResourceContainerGroup[])

public void SetGroups(params ResourceContainerGroup[] groups)

Parameters

groups ResourceContainerGroup[]

SetGroups(IEnumerable<ResourceContainerGroup>)

public void SetGroups(IEnumerable<ResourceContainerGroup> groups)

Parameters

groups IEnumerable<ResourceContainerGroup>

SetResourceFillRatio(ResourceDefinitionID, double)

public double SetResourceFillRatio(ResourceDefinitionID resourceID, double percentOfCapacity)

Parameters

resourceID ResourceDefinitionID
percentOfCapacity double

Returns

double

SetResourceStoredUnits(ResourceDefinitionID, double)

public double SetResourceStoredUnits(ResourceDefinitionID resourceID, double unitsToSet)

Parameters

resourceID ResourceDefinitionID
unitsToSet double

Returns

double

StorePreProcessedResourceUnits(ResourceDefinitionID, double)

public double StorePreProcessedResourceUnits(ResourceDefinitionID resourceID, double totalUnitsToStore)

Parameters

resourceID ResourceDefinitionID
totalUnitsToStore double

Returns

double

TryGetResourceContainedData(ResourceDefinitionID, out ContainedResourceData)

public bool TryGetResourceContainedData(ResourceDefinitionID resourceID, out ContainedResourceData data)

Parameters

resourceID ResourceDefinitionID
data ContainedResourceData

Returns

bool