Class StairsTool

Namespace

TinyLife.Tools

Assembly

TinyLife.dll

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 StairsTool : Tool

Inheritance

object

Tool

StairsTool

Inherited Members

Tool.RemoveTool

Tool.MoveTool

Tool.PlayModeTool

Tool.FurnitureTool

Tool.BuildTools

Tool.SelectedObject

Tool.SelectedWall

Tool.SelectedRoof

Tool.SelectedStairs

Tool.IsRotateCwPressed

Tool.IsRotateCcwPressed

Tool.IsCopyPressed

Tool.OnOpened

Tool.OnClosed

Tool.OnUpdate

Tool.OnDraw

Tool.OnInitBuildModeUi

Tool.Input

Tool.Map

Tool.Money

Tool.CurrentFloor

Tool.Name

Tool.Texture

Tool.DisplayAsTab

Tool.Keybind

Tool.MousePos

Tool.Opened()

Tool.Closed()

Tool.OpenedAfterOverride()

Tool.ClosedByOverride()

Tool.GetMouseCursor()

Tool.CanPlaceForTooltip()

Tool.CanSwitchGameModes()

Tool.CanUndoRedo(bool)

Tool.OnButtonCreated(Button)

Tool.IsOnLot(Point)

Tool.ColorSelection(ColorSettings, Action<int, int>, Func<int, int, bool>, LnCategory)

Tool.ColorSelection(ColorScheme, Color, Action<int>, Func<int, bool>, string)

Tool.BuildModeButton(string, string, Element.GenericCallback, Element.DrawCallback, float, TextureRegion, string, IEnumerable<string>, float?)

Tool.BuildModeButton(string, string, Element.GenericCallback, Element.DrawCallback, float, IEnumerable<TextureRegion>, string, IEnumerable<string>, float?)

Tool.SelectFirstContentItem()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Extension Methods

Extensions.JsonCopy<T>(T)

Constructors

StairsTool()

public StairsTool()

Methods

Draw(GameTime, SpriteBatch, bool)

This method is called every draw frame for the CurrentTool. By default, this method invokes OnDraw.

public override void Draw(GameTime time, SpriteBatch batch, bool cursorOnUi)

Parameters

time GameTime

The game's time

batch SpriteBatch

The sprite batch used for drawing

cursorOnUi bool

Whether the cursor is currently covering the ui.

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 Panel

The main content panel. Add custom BuildModeButton(string, string, GenericCallback, DrawCallback, float, IEnumerable<TextureRegion>, string, IEnumerable<string>, float?) instances here.

zoom Panel

The zoom panel that contains ColorSelection(ColorSettings, Action<int, int>, Func<int, int, bool>, LnCategory) and object previews

ShouldHighlightSelectedObject(object)

Whether or not the selected object 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

obj object

The selected object, which can be a MapObject, a WallLike, a Roof or a Stairs object.

Returns

bool

Whether or not the selected object should be highlighted

Update(GameTime, bool)

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, bool cursorOnUi)

Parameters

time GameTime

The game's time

cursorOnUi bool

Whether the cursor is currently covering the ui.