Loading...
Searching...
No Matches
CityBuilderCore.BaseTool Class Referenceabstract

Detailed Description

base class for tools that are managed by ToolsManager
gets activated, deactivated, has a cost, ...
in general tools are buttons in the UI that can be clicked to interact with the game world using the pointer
for exmaple placing or demolishing buildings and structures

https://citybuilder.softleitner.com/manual

Inheritance diagram for CityBuilderCore.BaseTool:
CityBuilderCore.TooltipOwnerBase CityBuilderCore.ITooltipOwner CityBuilderCore.PointerToolBase CityBuilderCore.SelectionTool CityBuilderCore.Tests.DebugMoveTool CityBuilderCore.BuildingBuilder CityBuilderCore.DemolishTool CityBuilderCore.ExpandableBuilder CityBuilderCore.MoveTool CityBuilderCore.RoadBuilder CityBuilderCore.StructureBuilder CityBuilderTown.TownDemolishTool CityBuilderTown.TownHarvestTool CityBuilderTown.TownPathTool CityBuilderTown.TownStartupTool

Public Member Functions

virtual void ActivateTool ()
 
virtual void DeactivateTool ()
 
virtual int GetCost (Item item)
 
- Public Member Functions inherited from CityBuilderCore.TooltipOwnerBase
void OnPointerEnter (PointerEventData eventData)
 
void OnPointerExit (PointerEventData eventData)
 

Public Attributes

View View
 
ToolEvent Activating
 
ToolEvent Applied
 

Protected Member Functions

void onApplied ()
 
virtual void updateTool ()
 
- Protected Member Functions inherited from CityBuilderCore.TooltipOwnerBase
virtual void OnDisable ()
 
void enter ()
 
void exit ()
 

Properties

virtual bool ShowGrid [get]
 whether the IGridOverlay gets shown for this tool
 
virtual bool IsTouchPanAllowed [get]
 whether the camera can be panned by touch drag
 
bool IsToolActive [get]
 
bool IsTouchActivated [get]
 
- Properties inherited from CityBuilderCore.TooltipOwnerBase
virtual string TooltipName [get]
 main text in the tooltip
 
virtual string TooltipDescription [get]
 smaller but potentially longer text below the main text
 
- Properties inherited from CityBuilderCore.ITooltipOwner

Additional Inherited Members

- Protected Attributes inherited from CityBuilderCore.TooltipOwnerBase
bool _isPointerInside