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

Detailed Description

special base class for tools that use the pointer
handles differences between mouse/touch
manages mouse down/up for dragging

https://citybuilder.softleitner.com/manual

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

Public Member Functions

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

Public Attributes

bool AllowTouchPan
 
- Public Attributes inherited from CityBuilderCore.BaseTool
View View
 
ToolEvent Activating
 
ToolEvent Applied
 

Protected Member Functions

virtual void Start ()
 
override void updateTool ()
 
void updatePointer (Vector2Int mousePoint, Vector2Int dragStart, bool isDown, bool isApply)
 
- Protected Member Functions inherited from CityBuilderCore.BaseTool
void onApplied ()
 
- Protected Member Functions inherited from CityBuilderCore.TooltipOwnerBase
virtual void OnDisable ()
 
void enter ()
 
void exit ()
 

Properties

override bool IsTouchPanAllowed [get]
 
- Properties inherited from CityBuilderCore.BaseTool
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
 

Member Function Documentation

◆ DeactivateTool()

override void CityBuilderCore.PointerToolBase.DeactivateTool ( )
inlinevirtual

Reimplemented from CityBuilderCore.BaseTool.

◆ updateTool()

override void CityBuilderCore.PointerToolBase.updateTool ( )
inlineprotectedvirtual

Reimplemented from CityBuilderCore.BaseTool.