Table of Contents

Namespace TinyLife.Utilities

Classes

AppliedMigrations

A class that handles the application of Migration actions on objects that are being validated or loaded from disk.

ColorScheme

A color scheme is a list of Microsoft.Xna.Framework.Color instances with which an object can be colored. By default, a set of color schemes exist (defined in this class), but new ones can be created easily using Create(params object[]).

Extensions

A set of extensions for dealing with various things required by Tiny Life.

Migration

A migration represents an action or set of actions that need to be done to an object to update it to the game's current version. Migrations are available for a multitude of object types that inhabit a Map, ExportedHousehold or ExportedLot by default. Note that migrations do not have to be registered using Register<T>(IEnumerable<Migration<T>>) when added to a preexisting collection like Migrations or Migrations, but only when a mod adds a custom set of migrations for a custom object type.

Migration<T>

A generic migration represents an action or set of actions that need to be done to an object of type T to update it to the game's current version. Migrations are available for a multitude of object types that inhabit a Map, ExportedHousehold or ExportedLot by default. Note that migrations do not have to be registered using Register<T>(IEnumerable<Migration<T>>) when added to a preexisting collection like Migrations or Migrations, but only when a mod adds a custom set of migrations for a custom object type.

SelectionHandler

The selection handler is responsible for handling the selection of objects, walls, roofs and stairs in the game world through pixel-perfect selection with the mouse using a RenderTarget that assigns a unique color to each object. For modders, this class holds various events that can be subscribed to in order to be notified when the selected object changes.

TextureHandler

The texture handler stores data for the game's textures, including all of the game's internal textures and various utility methods. It also stores the game's MLEM.Data.RuntimeTexturePacker which is used to pack all textures into a big texture for performance.

Structs

ColorSettings

Color settings are a collection of color schemes that can be used to color an object. They also contain a mapping of which layers should use which color schemes, and a set of default color schemes. Color settings are most notably used by FurnitureType.TypeSettings, as well as other objects in the world.

Enums

MigrationPhase

A migration phase represents the time in an object's validation or loading process at which a Migration should be applied.

MigrationResult

A migration result that signifies whether a Migration was successful, failed or was skipped.

Delegates

Migration.ApplyDelegate

A delegate method used for Apply. The passed JSON extension data is additional data that is loaded from disk, but didn't have an appropriate property or field to store it in. This can be useful for migrating objects whose property or field names changed.

TextureHandler.GameContentLoadedDelegate

A delegate used by OnGameContentLoaded.

TextureHandler.LoadGameContentDelegate

A delegate used by OnLoadGameContent.