Table of Contents

Class FurnitureMail

Namespace
TinyLife.World
Assembly
Tiny Life.dll

A Mail that contains a furniture item, and that can be opened using GetFurnitureMail.

public class FurnitureMail : Mail, IGenericDataHolder
Inheritance
JsonTypeSafeGenericDataHolder
FurnitureMail
Implements
IGenericDataHolder
Inherited Members
JsonTypeSafeGenericDataHolder.GetDataKeys()
Extension Methods

Constructors

FurnitureMail(Guid, Furniture)

public FurnitureMail(Guid receivingLot, Furniture item)

Parameters

receivingLot Guid
item Furniture

Fields

Item

The furniture item to receive in the mail.

[DataMember]
public readonly Furniture Item

Field Value

Furniture

Methods

OnCollected(Action)

A method that is called when the Item is collected as part of the given Action. This method is called in GetFurnitureMail.

public virtual void OnCollected(Action action)

Parameters

action Action

The action.

Validate(Map, AppliedMigrations)

Validates this mail and returns false if it is somehow invalid. This method is called when a save is loaded.

public override bool Validate(Map map, AppliedMigrations appliedMigrations)

Parameters

map Map

The map that this mail is on.

appliedMigrations AppliedMigrations

The set of migrations that have already been applied for this object.

Returns

bool

Whether this mail is valid.