Class BaseSpawnConditions
- Namespace
- Vintagestory.API.Common.Entities
- Assembly
- VintagestoryAPI.dll
A base class for entities spawning conditions.
[DocumentAsJson]
public class BaseSpawnConditions : ClimateSpawnCondition
- Inheritance
-
BaseSpawnConditions
- Derived
- Inherited Members
Fields
Group (Recommended) (Default: None)
The group of the spawn conditions. Vanilla groups are:
- hostile
- neutral
- passive
Hostile creatures should be defined as such here. This will automatically stop them spawning with a grace timer, and in locations where hostiles should not spawn.
[DocumentAsJson]
public string Group
Field Value
HerdSize (Recommended) (Default: 1)
the group size for the spawn.
[DocumentAsJson]
public NatFloat HerdSize
Field Value
ClimateValueMode (Optional) (Default: WorldGenValues)
Whether the rain and temperature values are referring to the worldgen values (i.e. yearly averages) or the current values at the moment of spawning.
[DocumentAsJson]
public EnumGetClimateMode ClimateValueMode
Field Value
Companions (Optional) (Default: None)
Additional companions for the spawn.
[DocumentAsJson]
public AssetLocation[] Companions
Field Value
InsideBlockCodes (Optional) (Default: "air")
The blocks that the object will spawn in.
[DocumentAsJson]
public AssetLocation[] InsideBlockCodes
Field Value
LightLevelType (Optional) (Default: MaxLight)
The type of light counted for spawning purposes.
[DocumentAsJson]
public EnumLightLevelType LightLevelType
Field Value
MaxLightLevel (Optional) (Default: 32)
The maximum light level for an object to spawn.
[DocumentAsJson]
public int MaxLightLevel
Field Value
MinLightLevel (Optional) (Default: 0)
The minimum light level for an object to spawn.
[DocumentAsJson]
public int MinLightLevel
Field Value
RequireSolidGround (Optional) (Default: true)
Checks to see if the object requires solid ground.
[DocumentAsJson]
public bool RequireSolidGround
Field Value
TryOnlySurface (Optional) (Default: false)
checks to see if the object can only spawn in the surface.
[DocumentAsJson]
public bool TryOnlySurface
Field Value
GroupSize (Obsolete)
Obsolete. Use HerdSize instead.
[DocumentAsJson]
[Obsolete("Use HerdSize instead")]
public NatFloat GroupSize { get; set; }