Class ShroomColonyInstance

Namespace

S1API.Growing

Assembly

S1API.dll

Represents an instance of a mushroom colony growing in the world.

public sealed class ShroomColonyInstance

Inheritance

object

ShroomColonyInstance

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Extension Methods

ReflectionUtils.GetValueTupleItems(object)

ReflectionUtils.IsValueTuple(object)

Remarks

Mushroom colonies grow in mushroom beds and require cool temperatures (≤15°F) to grow properly. Each colony can produce multiple individual mushrooms that can be harvested.

Fields

MaxTemperatureForGrowth

The maximum temperature (in Fahrenheit) at which mushrooms can grow.

public const float MaxTemperatureForGrowth = 15

Field Value

float

Properties

BaseShroomYield

The base yield of mushrooms this colony will produce when fully grown.

public int BaseShroomYield { get; }

Property Value

int

GameObject

The GameObject of the colony.

public GameObject GameObject { get; }

Property Value

GameObject

GrownMushroomCount

The number of individual mushrooms currently grown in this colony.

public int GrownMushroomCount { get; }

Property Value

int

GrowthProgress

The current growth progress as a float from 0.0 to 1.0.

public float GrowthProgress { get; }

Property Value

float

IsFullyGrown

Whether the colony is fully grown and ready for harvest.

public bool IsFullyGrown { get; }

Property Value

bool

IsTooHotToGrow

Whether the colony's temperature is too hot for growth. Mushrooms require temperatures at or below 15°F to grow.

public bool IsTooHotToGrow { get; }

Property Value

bool

NormalizedQuality

The normalized quality level of this colony (0.0 to 1.0).

public float NormalizedQuality { get; }

Property Value

float

Methods

Destroy()

Destroys this mushroom colony in-game.

public void Destroy()

Remarks

This will remove the colony and all its mushrooms from the world. Use with caution as this operation cannot be undone.