Class FurnitureTool
A tool is a type of game mode that is currently active. Tools are split up into the PlayModeTool and BuildTools, the latter of which holds all tools that can be found in the build menu.
Inherited Members
Namespace: TinyLife.Tools
Assembly: Tiny Life.dll
Syntax
public class FurnitureTool : Tool
Constructors
FurnitureTool()
Declaration
public FurnitureTool()
Methods
Closed()
Called when this build tool is closed. By default, this method removes its elements from the ui.
Declaration
public override void Closed()
Overrides
Draw(GameTime, SpriteBatch)
This method is called every draw frame for the CurrentTool. Note that this method is only called if the mouse is not hovering over any ui elements. By default, this method invokes OnDraw.
Declaration
public override void Draw(GameTime time, SpriteBatch batch)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.Xna.Framework.GameTime | time | The game's time |
Microsoft.Xna.Framework.Graphics.SpriteBatch | batch | The sprite batch used for drawing |
Overrides
GetMouseCursor()
Returns the CursorType that this tool should currently display. By default, Default is returned.
Declaration
public override CursorType GetMouseCursor()
Returns
Type | Description |
---|---|
CursorType | The cursor type |
Overrides
InitBuildModeUi(Panel, Panel)
Override this method to add custom content to the passed ui elements. By default, this method does nothing.
Declaration
protected override void InitBuildModeUi(Panel content, Panel zoom)
Parameters
Type | Name | Description |
---|---|---|
MLEM.Ui.Elements.Panel | content | The main content panel. Add custom BuildModeButton(String, Element.GenericCallback, Element.DrawCallback, Single, TextureRegion, IEnumerable<String>, Nullable<Single>) instances here. |
MLEM.Ui.Elements.Panel | zoom | The zoom panel that contains ColorSelection(ColorScheme[], Action<Int32, Int32>, Func<Int32, Int32, Boolean>) and object previews |
Overrides
ShouldHighlightSelectedObject(Object)
Whether or not the SelectedObject should currently have a white highlight around it. This method defaults to return true if IsCursorOnUi() is false.
Declaration
public override bool ShouldHighlightSelectedObject(object obj)
Parameters
Type | Name | Description |
---|---|---|
System.Object | obj |
Returns
Type | Description |
---|---|
System.Boolean | Whether or not the selected object should be highlighted |
Overrides
Update(GameTime)
This method is called every update frame for the CurrentTool. By default, this method updates the MousePos and invokes OnUpdate, and also manages the UndoRedoStack.
Declaration
public override void Update(GameTime time)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.Xna.Framework.GameTime | time | The game's time |