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.
public class FurnitureTool : Tool
- Inheritance
-
FurnitureTool
- Inherited Members
- Extension Methods
Constructors
FurnitureTool()
public FurnitureTool()
Methods
Closed()
Called when this build tool is closed. By default, this method removes its elements from the ui.
public override void Closed()
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.
public override void Draw(GameTime time, SpriteBatch batch)
Parameters
time
GameTimeThe game's time
batch
SpriteBatchThe sprite batch used for drawing
GetMouseCursor()
Returns the CursorType that this tool should currently display. By default, Default is returned.
public override CursorType GetMouseCursor()
Returns
- CursorType
The cursor type
InitBuildModeUi(Panel, Panel)
Override this method to add custom content to the passed ui elements. By default, this method does nothing.
protected override void InitBuildModeUi(Panel content, Panel zoom)
Parameters
content
PanelThe main content panel. Add custom BuildModeButton(string, GenericCallback, DrawCallback, float, TextureRegion, IEnumerable<string>, float?) instances here.
zoom
PanelThe zoom panel that contains ColorSelection(ColorScheme[], Action<int, int>, Func<int, int, bool>) and object previews
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.
public override bool ShouldHighlightSelectedObject(object obj)
Parameters
Returns
- bool
Whether or not the selected object should be highlighted
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.
public override void Update(GameTime time)
Parameters
time
GameTimeThe game's time