CityBuilderTown.TownHarvestTool Class Reference

Detailed Description

tool that places TownHarvestTask at points that have structures that match a harvest tasks PrimaryStructureKey
harvest tasks have to be known to TownManager

https://citybuilder.softleitner.com/manual/town

Inheritance diagram for CityBuilderTown.TownHarvestTool:

Public Attributes
string	Name
Public Attributes inherited from CityBuilderCore.PointerToolBase
bool	AllowTouchPan
Public Attributes inherited from CityBuilderCore.BaseTool
View	View
ToolEvent	Activating
ToolEvent	Applied

Protected Member Functions
override void	Start ()
override void	updatePointer (Vector2Int mousePoint, Vector2Int dragStart, bool isDown, bool isApply)
Protected Member Functions inherited from CityBuilderCore.PointerToolBase
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 string	TooltipName [get]
	main text in the tooltip
Properties inherited from CityBuilderCore.PointerToolBase
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
Public Member Functions inherited from CityBuilderCore.PointerToolBase
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)
Protected Attributes inherited from CityBuilderCore.TooltipOwnerBase
bool	_isPointerInside

Member Function Documentation

Start()

override void CityBuilderTown.TownHarvestTool.Start ( )

inlineprotectedvirtual

Reimplemented from CityBuilderCore.PointerToolBase.

Property Documentation

TooltipName

override string CityBuilderTown.TownHarvestTool.TooltipName

get

main text in the tooltip

Implements CityBuilderCore.ITooltipOwner.