AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle Interface Reference

Implement this on the representation of a single source for some consumable. More...

Inheritance diagram for AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle:

Collaboration diagram for AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle:

Public Member Functions
void	ModifyBy (Quantity relativeAmount)
	Change the currently active amount available in this puddle.
void	SetTo (Quantity absoluteAmount)
	Set the currently available amount.

Properties
IConsumablePool	ParentPool [get]
	Cross-link back to the pool to which this puddle belongs.
string	Location [get]
	Location information for this consumable that is meaningful to a task that consumes something - like a bottle name, vial position...
Quantity	MaxLevel [get]
	How many units of this consumable are at best available here?
Quantity	CurrentLevel [get]
	How many units of this consumable are currently available here?

Detailed Description

Implement this on the representation of a single source for some consumable.

Definition at line 11 of file IConsumablePuddle.cs.

Member Function Documentation

ModifyBy()

void AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.ModifyBy

(

Quantity

relativeAmount

)

Change the currently active amount available in this puddle.

Parameters

relativeAmount

By how much does the content of the puddle change? Positive if you add something, negative if you take something

Returns

SetTo()

void AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.SetTo

(

Quantity

absoluteAmount

)

Set the currently available amount.

Parameters

absoluteAmount

Like in ModifyBy

Property Documentation

CurrentLevel

Quantity AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.CurrentLevel

get

How many units of this consumable are currently available here?

Definition at line 28 of file IConsumablePuddle.cs.

{ get; }

Location

string AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.Location

get

Location information for this consumable that is meaningful to a task that consumes something - like a bottle name, vial position...

Definition at line 20 of file IConsumablePuddle.cs.

{ get; }

MaxLevel

Quantity AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.MaxLevel

get

How many units of this consumable are at best available here?

Definition at line 24 of file IConsumablePuddle.cs.

{ get; }

ParentPool

IConsumablePool AxelSemrau.Chronos.Plugin.Consumables.IConsumablePuddle.ParentPool

get

Cross-link back to the pool to which this puddle belongs.

Definition at line 16 of file IConsumablePuddle.cs.

{ get; }

---

The documentation for this interface was generated from the following file:

• IConsumablePuddle.cs