TinyLifeExampleMod/Api/TinyLife/World/OpeningType.md

OpeningType

Namespace: TinyLife > World

Assembly: Tiny Life.dll

Summary

An opening is some sort of extrusion in a TinyLife.World.Wall, like a window or a door. An opening type stores data that can be used to construct a TinyLife.World.Opening instance.

Constructors

Name	Summary
OpeningType ( String, TextureRegion, WallMode, Int32, Func<OpeningType, Int32, Wall, Opening>, ColorScheme, TextureRegion )	Creates a new opening type with the given settings

Fields

Type	Name	Summary
ColorScheme	ColorScheme	The color scheme that opening instances can have when created from this type
TextureRegion	Icon	The build mode icon for this object, which represents the category / theme / mod that it comes from. If this value is nonnull, the icon will be displayed in the corner of the build mode button for this object.
String	Name	The name of this opening type
Int32	Price	The price of this opening
WallMode	WallMode	The TinyLife.World.OpeningType.WallMode that TinyLife.World.Wall instances with this opening in it should use for rendering

Methods

Return	Name	Summary
Opening	Construct ( Int32, Wall )	Constructs a new TinyLife.World.Opening instance from this opening type
void	Draw ( GameTime, SpriteBatch, Vector2, Boolean, Single, Single, Int32 )	Draws this opening in a wall
void	DrawUi ( Element, SpriteBatch, GameTime, Int32, Single )	Draws this opening in ui space rather than world space

Static Fields

Type	Name	Summary
IDictionary<String, OpeningType>	Types	A registry for all TinyLife.World.OpeningType instances from the game and mods. Use TinyLife.World.OpeningType.Register(TinyLife.World.OpeningType) to register custom opening types.

Static Methods

Return	Name	Summary
void	Register ( OpeningType )	Registers the given TinyLife.World.OpeningType to the TinyLife.World.OpeningType.Types registry