Class MushroomBedInstance

Namespace

S1API.Growing

Assembly

S1API.dll

Represents an instance of a mushroom bed in the world.

public sealed class MushroomBedInstance

Inheritance

object

MushroomBedInstance

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 beds are specialized growing containers that can hold mushroom colonies. They require cool temperatures (maintained by AC units) for optimal mushroom growth.

Properties

CurrentColony

The mushroom colony currently growing in this bed, or null if empty.

public ShroomColonyInstance CurrentColony { get; }

Property Value

ShroomColonyInstance

GameObject

The GameObject of the mushroom bed.

public GameObject GameObject { get; }

Property Value

GameObject

Transform

The transform of the mushroom bed.

public Transform Transform { get; }

Property Value

Transform

Methods

ContainsGrowable()

Whether this mushroom bed currently contains a growing mushroom colony.

public bool ContainsGrowable()

Returns

bool

GetAverageTileTemperature()

Gets the average temperature of the tiles under this mushroom bed.

public float GetAverageTileTemperature()

Returns

float

The average temperature in Fahrenheit.

GetGrowSurfaceSideLength()

Gets the side length of the grow surface in world units.

public float GetGrowSurfaceSideLength()

Returns

float

The side length of the internal grow surface.

GetGrowthProgressNormalized()

Gets the current growth progress of the mushroom colony (0.0 to 1.0). Returns 0 if no colony is present.

public float GetGrowthProgressNormalized()

Returns

float

IsReadyForHarvest(out string)

Checks if the mushroom bed is ready for harvest.

public bool IsReadyForHarvest(out string reason)

Parameters

reason string

Output parameter that contains the reason if not ready for harvest.

Returns

bool

True if ready for harvest, false otherwise.