TinyLifeExampleMod/Api/TinyLife/World/LotType.md

LotType

Namespace: TinyLife > World

Assembly: Tiny Life.dll

Summary

A lot type is data for a TinyLife.World.Lot that determines the required furniture on the lot as well as whether the lot is residential or not. Additionally, custom lot types can define different reasons and interactions for TinyLife.Objects.Person objects to visit lots of the type.

Constructors

Name	Summary
LotType ( String, Boolean, Func<Lot, Person, Int32>, ValueTuple[]<FurnitureType, Int32> )

Fields

Type	Name	Summary
Func<Lot, Person, Int32>	GetVisitPriority	A function that returns, for a TinyLife.World.Lot with this lot type, and a TinyLife.Objects.Person trying ot visit the lot, how likely it is for the lot to be chosen. The higher the return value is, the more likely it is for this lot to be chosen. For reference, the "Park" lot type always returns 200.
Boolean	IsResidential	Whether this lot is residential. A residential lot is one that TinyLife.World.Households can move into.
String	Name	The name of this lot type
ValueTuple[]<FurnitureType, Int32>	RequiredFurniture	A set of furniture that is required on the lot. Each entry determines the TinyLife.Objects.FurnitureType required, as well as the amount of that item that is required on the lot.

Static Fields

Type	Name	Summary
IDictionary<String, LotType>	Types	A registry for all TinyLife.World.LotType objects that the game and mods define

Static Methods

Return	Name	Summary
void	Register ( LotType )	Registers a new lot type to the TinyLife.World.LotType.Types registry