OrganismStateUpperBoundaryForEnergyState Method |
Returns the amount of energy required to be at the top of a given EnergyState.
It's recommended that the actual EnergyState property be used to determine
the current energy bucket a creature is in.
Namespace: Terrarium.Sdk.Classes.StateAssembly: Terrarium.Sdk (in Terrarium.Sdk.dll) Version: 1.1.0.0 (1.1.0.0)
Syntaxpublic static double UpperBoundaryForEnergyState(
ISpecies species,
EnergyState energyState,
int radius
)
Public Shared Function UpperBoundaryForEnergyState (
species As ISpecies,
energyState As EnergyState,
radius As Integer
) As Double
public:
static double UpperBoundaryForEnergyState(
ISpecies^ species,
EnergyState energyState,
int radius
)
static member UpperBoundaryForEnergyState :
species : ISpecies *
energyState : EnergyState *
radius : int -> float
Parameters
- species
- Type: Terrarium.Sdk.InterfacesISpecies
The species for which to calculate - energyState
- Type: Terrarium.Sdk.EnumerationsEnergyState
EnergyState enum value for the bucket to get the upper energy bounding for. - radius
- Type: SystemInt32
The radius of the organism to use in calculation
Return Value
Type:
Double
System.Double representing the amount of energy to be at the top of a given energy state.
See Also