Class ClimateSpawnCondition
- Namespace
- Vintagestory.API.Common.Entities
- Assembly
- VintagestoryAPI.dll
A list of conditions based on climate. Open in GitHub
[DocumentAsJson]
public class ClimateSpawnCondition
- Inheritance
-
ClimateSpawnCondition
- Derived
- Inherited Members
- Extension Methods
Fields
HabitatSize
If true, will check for suitable habitat size (e.g. when underwater and size of 2 will check that there is also water 2 blocks away in all directions For habitat land: Not implemented yet For habitat air: Not implemented yet
[DocumentAsJson("Optional", "true", false)]
public int HabitatSize
Field Value
MapCode
[JsonIgnore]
public string? MapCode
Field Value
MaxForest
The maximum amount of forest cover needed for the object to spawn.
[DocumentAsJson("Optional", "1", false)]
public float MaxForest
Field Value
MaxRain
The maximum amount of rain for the object to spawn.
[DocumentAsJson("Optional", "1", false)]
public float MaxRain
Field Value
MaxShrubs
The maximum amount of shrubbery needed for the object to spawn.
[DocumentAsJson("Optional", "1", false)]
public float MaxShrubs
Field Value
MaxTemp
The maximum tempurature for the object to spawn.
[DocumentAsJson("Optional", "40", false)]
public float MaxTemp
Field Value
MaxY
Won't span above maxY. 0...1 is world bottom to sea level, 1...2 is sea level to world top
[DocumentAsJson("Optional", "2", false)]
public float MaxY
Field Value
MinForest
The minimum amount of forest cover needed for the object to spawn.
[DocumentAsJson("Optional", "0", false)]
public float MinForest
Field Value
MinForestOrShrubs
The minimum amount of forest or shrubs for the object to spawn.
[DocumentAsJson("Optional", "0", false)]
public float MinForestOrShrubs
Field Value
MinRain
The minimum amount of rain for the object to spawn.
[DocumentAsJson("Optional", "0", false)]
public float MinRain
Field Value
MinShrubs
The minimum amount of shrubbery needed for the object to spawn.
[DocumentAsJson("Optional", "0", false)]
public float MinShrubs
Field Value
MinTemp
The minimum tempurature for the object to spawn.
[DocumentAsJson("Optional", "-40", false)]
public float MinTemp
Field Value
MinY
Won't span below minY. 0...1 is world bottom to sea level, 1...2 is sea level to world top
[DocumentAsJson("Optional", "0", false)]
public float MinY
Field Value
RandomMapCodePool
If defined, further constrains the spawning areas by a large scale 2D density map
[DocumentAsJson("Optional", "null", false)]
public string[]? RandomMapCodePool
Field Value
- string[]
Methods
Clone()
public ClimateSpawnCondition Clone()
Returns
Matches(ClimateCondition?, int, ICoreServerAPI)
public bool Matches(ClimateCondition? climate, int y, ICoreServerAPI sapi)
Parameters
climateClimateConditionyintsapiICoreServerAPI
Returns
MatchesClimate(ClimateCondition)
public bool MatchesClimate(ClimateCondition climate)
Parameters
climateClimateCondition
Returns
MatchesForestation(ClimateCondition)
public bool MatchesForestation(ClimateCondition climate)
Parameters
climateClimateCondition
Returns
SetFrom(ClimateSpawnCondition)
public void SetFrom(ClimateSpawnCondition conds)
Parameters
condsClimateSpawnCondition