TinyLifeExampleMod/Api/TinyLife/Tools/FurniturePlacer.md

FurniturePlacer

Namespace: TinyLife > Tools

Assembly: Tiny Life.dll

Summary

A helper class that represents a tool part which allows the placement and movement of furniture objects. This class is used by TinyLife.Tools.FurnitureTool and TinyLife.Tools.MoveTool.

Constructors

Name	Summary
FurniturePlacer ( Action<Furniture> )	Creates a new furniture placer with the given settings

Properties

Type	Name	Summary
Int32[]	SelectedColors	The color indices that are currently selected for the TinyLife.Tools.FurniturePlacer.SelectedFurniture
FurnitureType	SelectedFurniture	The TinyLife.Objects.FurnitureType that is currently selected for placement
Furniture	SelectedPreview	An instance of the TinyLife.Tools.FurniturePlacer.SelectedFurniture

Methods

Return	Name	Summary
void	Draw ( GameTime, SpriteBatch )	Draws the TinyLife.Tools.FurniturePlacer.SelectedPreview of this furniture placer
Nullable<WallDisplay>	ForceWallsUp ( )
CursorType	GetMouseCursor ( )
Boolean	HighlightSelectedObject ( )
void	SelectFurniture ( FurnitureType, Furniture, Action<Furniture>, Direction2, Int32[], Boolean )	Selects the given TinyLife.Objects.FurnitureType. If is enabled, the is the exact furniture instance that will be placed. If it is false, a new instance of the given `` will be created upon placement.
void	Update ( )	Updates this furniture placer. This should be called in TinyLife.Tools.Tool.Update(Microsoft.Xna.Framework.GameTime) each frame.