CityBuilderCore.SpriteHighlightManager Class Reference

Detailed Description

implementation of IHighlightManager that instantiates sprites

https://citybuilder.softleitner.com/manual

Inheritance diagram for CityBuilderCore.SpriteHighlightManager:

Public Member Functions
void	Highlight (IEnumerable< Vector2Int > points, bool valid)
	highlights points on the map
void	Highlight (IEnumerable< Vector2Int > points, HighlightType type)
	highlights points on the map
void	Highlight (IEnumerable< Vector2Int > points, Color color)
	highlights points on the map
void	Highlight (Vector2Int point, bool isValid)
	highlights a point on the map
void	Highlight (Vector2Int point, HighlightType type)
	highlights a point on the map
void	Highlight (Vector2Int point, Color color)
	highlights points on the map
void	Clear ()
	removes any previously made highlights

Public Attributes
SpriteRenderer	Prefab
Color	ValidColor = Color.green
Color	InvalidColor = Color.red
Color	InfoColor = Color.blue

Protected Member Functions
virtual void	Awake ()

Member Function Documentation

Clear()

void CityBuilderCore.SpriteHighlightManager.Clear ( )

inline

removes any previously made highlights

Implements CityBuilderCore.IHighlightManager.

Highlight() [1/6]

void CityBuilderCore.SpriteHighlightManager.Highlight	(	IEnumerable< Vector2Int >	points,
		bool	valid )

highlights points on the map

Parameters

points	points on the map to highlight
valid	true to display as valid(green), false for invalid(red)

Implements CityBuilderCore.IHighlightManager.

Highlight() [2/6]

void CityBuilderCore.SpriteHighlightManager.Highlight ( IEnumerable< Vector2Int > points, Color color )

inline

highlights points on the map

Parameters

points	points on the map to highlight
color	color to visualize the highlight in

Implements CityBuilderCore.IHighlightManager.

Highlight() [3/6]

void CityBuilderCore.SpriteHighlightManager.Highlight	(	IEnumerable< Vector2Int >	points,
		HighlightType	type )

highlights points on the map

Parameters

points	points on the map to highlight
type	how the points should be visualized(valid>green, invalid>red, info>blue)

Implements CityBuilderCore.IHighlightManager.

Highlight() [4/6]

void CityBuilderCore.SpriteHighlightManager.Highlight	(	Vector2Int	point,
		bool	isValid )

highlights a point on the map

Parameters

point	point on the map to highlight
valid	true to display as valid(green), false for invalid(red)

Implements CityBuilderCore.IHighlightManager.

Highlight() [5/6]

void CityBuilderCore.SpriteHighlightManager.Highlight ( Vector2Int point, Color color )

inline

highlights points on the map

Parameters

points	points on the map to highlight
color	color to visualize the highlight in

Implements CityBuilderCore.IHighlightManager.

Highlight() [6/6]

void CityBuilderCore.SpriteHighlightManager.Highlight	(	Vector2Int	point,
		HighlightType	type )

highlights a point on the map

Parameters

point	point on the map to highlight
type	how the points should be visualized(valid>green, invalid>red, info>blue)

Implements CityBuilderCore.IHighlightManager.