CityBuilderCore.ExpandableBuilder Class Reference

Detailed Description

special builder that can place ExpandableBuilding of dynamic size by dragging out the size

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

Inheritance diagram for CityBuilderCore.ExpandableBuilder:

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

Public Attributes
ExpandableBuildingInfo	BuildingInfo
bool	StartAtMinimum
bool	AllowRotate = true
UnityEvent< Building >	Built
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	updateTool ()
override void	updatePointer (Vector2Int mousePoint, Vector2Int dragStart, bool isDown, bool isApply)
virtual void	recreateGhost ()
virtual bool	checkCost (Vector2Int expansion)
virtual int	getExpansionCount (Vector2Int expansion)
virtual void	build (Vector2Int point, BuildingRotation rotation, Vector2Int expansion)
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 ()

Protected Attributes
BuildingRotation	_rotation
int	_index
IExpandableVisual	_ghost
List< ItemQuantity >	_costs = new List<ItemQuantity>()
IGlobalStorage	_globalStorage
IHighlightManager	_highlighting
IMap	_map
Protected Attributes inherited from CityBuilderCore.TooltipOwnerBase
bool	_isPointerInside

Properties
override string	TooltipName [get]
	main text in the tooltip
override string	TooltipDescription [get]
	smaller but potentially longer text below the main text
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

Member Function Documentation

ActivateTool()

override void CityBuilderCore.ExpandableBuilder.ActivateTool ( )

inlinevirtual

Reimplemented from CityBuilderCore.BaseTool.

DeactivateTool()

override void CityBuilderCore.ExpandableBuilder.DeactivateTool ( )

inlinevirtual

Reimplemented from CityBuilderCore.BaseTool.

GetCost()

override int CityBuilderCore.ExpandableBuilder.GetCost ( Item item )

inlinevirtual

Reimplemented from CityBuilderCore.BaseTool.

Start()

override void CityBuilderCore.ExpandableBuilder.Start ( )

inlineprotectedvirtual

Reimplemented from CityBuilderCore.PointerToolBase.

updateTool()

override void CityBuilderCore.ExpandableBuilder.updateTool ( )

inlineprotectedvirtual

Reimplemented from CityBuilderCore.BaseTool.

Property Documentation

TooltipDescription

override string CityBuilderCore.ExpandableBuilder.TooltipDescription

get

smaller but potentially longer text below the main text

Implements CityBuilderCore.ITooltipOwner.

TooltipName

override string CityBuilderCore.ExpandableBuilder.TooltipName

get

main text in the tooltip

Implements CityBuilderCore.ITooltipOwner.