CityBuilderCore.MoveTool Class Reference

Detailed Description

tool that moves one or more structures to a different position
which structures can be moved is determined by IStructure.IsMovable
this can be set in BuildingInfo for buildings, some structures have a checkbox

Inheritance diagram for CityBuilderCore.MoveTool:

Public Member Functions
override void	DeactivateTool ()
void	MoveOnce (IBuilding building)
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)

Public Attributes
string	Name
bool	AllowRotate = true
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
Protected Attributes inherited from CityBuilderCore.TooltipOwnerBase
bool	_isPointerInside

Member Function Documentation

DeactivateTool()

override void CityBuilderCore.MoveTool.DeactivateTool ( )

inlinevirtual

Reimplemented from CityBuilderCore.BaseTool.

Start()

override void CityBuilderCore.MoveTool.Start ( )

inlineprotectedvirtual

Reimplemented from CityBuilderCore.PointerToolBase.

Property Documentation

TooltipName

override string CityBuilderCore.MoveTool.TooltipName

get

main text in the tooltip

Implements CityBuilderCore.ITooltipOwner.