Inheritance diagram for CityBuilderCore.Tests.DebugMap:

Public Member Functions
bool	IsInside (Vector2Int point)
	checks if a point is inside the map size

bool	IsBuildable (Vector2Int point, int mask, object tag=null)
	checks if a point is ok to build on or if the map somehow blocks building there

bool	IsWalkable (Vector2Int point)
	check if a point can be walked on and may be used in pathfinding

bool	CheckGround (Vector2Int point, Object[] options)
	checks the ground for certain features for example in tilemap base maps this would be a tile

void	Show ()
	shows grid lines on the map

void	Hide ()
	hides grid lines on the map

Vector3	ClampPosition (Vector3 position)
	clamps a position to be inside the maps size if, for example, a position 5,-10 is passed for a map that starts at 0,0 the position will be clamped to 5,0

Vector2Int	ClampPoint (Vector2Int point)
	clamps a point to be inside the maps size

Vector2Int	GetGridPoint (Vector3 position)
	turns a world position into a map point

Vector3	GetWorldPosition (Vector2Int point)
	turns a map point into the world position in its lower corner(without height)

Vector3	GetCenterFromPosition (Vector3 position)
	calculates the cells center from its corner position to get the cell center from any position in it use Extensions.GetWorldCenterPosition(IGridPositions, Vector3)

Vector3	GetPositionFromCenter (Vector3 center)
	calculates the cells corner position from its center

Vector3	GetVariance ()
	get position variance for walkers and such, can be used so walkers on the same point dont overlap

void	SetRotation (Transform transform, Vector3 direction)
	adjusts a transform in order to visually reflect the direction it is facing

void	SetRotation (Transform transform, float rotation)
	adjusts a transform by a rotation in degrees

float	GetRotation (Vector3 _)
	calculates a numeric rotation in degrees from a direction

Vector3	GetDirection (float _)
	calculates a direction from a numeric roation

Public Attributes
Vector2Int	Size

Tilemap	Ground

TileBase[]	WalkingBlockingTiles

TileBase[]	BuildingBlockingTiles

MeshRenderer	GridVisual

Protected Member Functions
virtual void	Awake ()

Properties
bool	IsHex `[get]`
	whether we're on a hexagonal map which may need some special handling

bool	IsXY `[get]`
	whether the map grid is in xy, usually in 2d games 3d games often use Y as the height axis and have their grid in XZ

Vector3	CellOffset `[get]`
	delta position from one cell to the next

Vector3	WorldCenter `[get]`
	world position at the center of the map

Vector3	WorldSize `[get]`

Grid	Grid `[get]`

Properties inherited from CityBuilderCore.IMap

Member Function Documentation

◆ CheckGround()

bool CityBuilderCore.Tests.DebugMap.CheckGround	(	Vector2Int	point,
		Object[]	options )

inline

checks the ground for certain features
for example in tilemap base maps this would be a tile

Parameters

point	the point on the map to check
options	a set of features that would be acceptable

Returns: true if the ground exhibits one of the features

Implements CityBuilderCore.IMap.

◆ ClampPoint()

Vector2Int CityBuilderCore.Tests.DebugMap.ClampPoint ( Vector2Int point )

inline

clamps a point to be inside the maps size

Parameters

point a point that may or may not be inside the map

Returns: a point inside the map

Implements CityBuilderCore.IMap.

◆ ClampPosition()

Vector3 CityBuilderCore.Tests.DebugMap.ClampPosition ( Vector3 position )

inline

clamps a position to be inside the maps size
if, for example, a position 5,-10 is passed for a map that starts at 0,0 the position will be clamped to 5,0

Parameters

position the position to check

Returns: the clamped position

Implements CityBuilderCore.IMap.

◆ GetCenterFromPosition()

Vector3 CityBuilderCore.Tests.DebugMap.GetCenterFromPosition ( Vector3 position )

inline

calculates the cells center from its corner position
to get the cell center from any position in it use Extensions.GetWorldCenterPosition(IGridPositions, Vector3)

Parameters

position absolute world space position of the cell cornder

Returns: center of the cell in absolute world space

Implements CityBuilderCore.IGridPositions.

◆ GetDirection()

Vector3 CityBuilderCore.Tests.DebugMap.GetDirection ( float angle )

calculates a direction from a numeric roation

Parameters

angle rotation indegrees

Returns: direction the angle is facing

Implements CityBuilderCore.IGridRotations.

◆ GetGridPoint()

Vector2Int CityBuilderCore.Tests.DebugMap.GetGridPoint ( Vector3 position )

inline

turns a world position into a map point

Parameters

position absolute world space position(transform.position)

Returns: map point of the cell the position was inside

Implements CityBuilderCore.IGridPositions.

◆ GetPositionFromCenter()

Vector3 CityBuilderCore.Tests.DebugMap.GetPositionFromCenter ( Vector3 center )

inline

calculates the cells corner position from its center

Parameters

center absolute world space position of the cell center

Returns: corner of the cell in absolute world space

Implements CityBuilderCore.IGridPositions.

◆ GetRotation()

float CityBuilderCore.Tests.DebugMap.GetRotation ( Vector3 direction )

calculates a numeric rotation in degrees from a direction

Parameters

direction direction the object is facing

Returns: rotation in degrees

Implements CityBuilderCore.IGridRotations.

◆ GetVariance()

Vector3 CityBuilderCore.Tests.DebugMap.GetVariance ( )

inline

get position variance for walkers and such, can be used so walkers on the same point dont overlap

Returns

Implements CityBuilderCore.IMap.

◆ GetWorldPosition()

Vector3 CityBuilderCore.Tests.DebugMap.GetWorldPosition ( Vector2Int point )

inline

turns a map point into the world position in its lower corner(without height)

Parameters

point map/cell point

Returns: absolute world position in the corner of the cell

Implements CityBuilderCore.IGridPositions.

◆ Hide()

void CityBuilderCore.Tests.DebugMap.Hide ( )

hides grid lines on the map

Implements CityBuilderCore.IGridOverlay.

◆ IsBuildable()

bool CityBuilderCore.Tests.DebugMap.IsBuildable	(	Vector2Int	point,
		int	mask,
		object	tag = null )

inline

checks if a point is ok to build on or if the map somehow blocks building there

Parameters

point	the point on the map to check
mask	the structure levels to check, 0 for all

Returns

Implements CityBuilderCore.IMap.

◆ IsInside()

bool CityBuilderCore.Tests.DebugMap.IsInside ( Vector2Int point )

inline

checks if a point is inside the map size

Parameters

point the point to check

Returns: true if the point is inside the map

Implements CityBuilderCore.IMap.

◆ IsWalkable()

bool CityBuilderCore.Tests.DebugMap.IsWalkable ( Vector2Int point )

inline

check if a point can be walked on and may be used in pathfinding

Parameters

point the point to check

Returns: true if the point allows walkers to pass

Implements CityBuilderCore.IMap.

◆ SetRotation() [1/2]

void CityBuilderCore.Tests.DebugMap.SetRotation	(	Transform	transform,
		float	rotation )

inline

adjusts a transform by a rotation in degrees

Parameters

transform	the transform that will be chaned
rotation	the rotation in degrees

Implements CityBuilderCore.IGridRotations.

◆ SetRotation() [2/2]

void CityBuilderCore.Tests.DebugMap.SetRotation	(	Transform	transform,
		Vector3	direction )

inline

adjusts a transform in order to visually reflect the direction it is facing

Parameters

transform	the transform that will be changed
direction	the direction the entity moves or looks at

Implements CityBuilderCore.IGridRotations.

◆ Show()

void CityBuilderCore.Tests.DebugMap.Show ( )

shows grid lines on the map

Implements CityBuilderCore.IGridOverlay.

Property Documentation

◆ CellOffset

Vector3 CityBuilderCore.Tests.DebugMap.CellOffset

get

delta position from one cell to the next

Implements CityBuilderCore.IMap.

◆ IsHex

bool CityBuilderCore.Tests.DebugMap.IsHex

get

whether we're on a hexagonal map which may need some special handling

Implements CityBuilderCore.IMap.

◆ IsXY

bool CityBuilderCore.Tests.DebugMap.IsXY

get

whether the map grid is in xy, usually in 2d games
3d games often use Y as the height axis and have their grid in XZ

Implements CityBuilderCore.IMap.

◆ WorldCenter

Vector3 CityBuilderCore.Tests.DebugMap.WorldCenter

get

world position at the center of the map

Implements CityBuilderCore.IMap.

Public Member Functions

Public Attributes

Protected Member Functions

Properties

Member Function Documentation

◆ CheckGround()

◆ ClampPoint()

◆ ClampPosition()

◆ GetCenterFromPosition()

◆ GetDirection()

◆ GetGridPoint()

◆ GetPositionFromCenter()

◆ GetRotation()

◆ GetVariance()

◆ GetWorldPosition()

◆ Hide()

◆ IsBuildable()

◆ IsInside()

◆ IsWalkable()

◆ SetRotation() [1/2]

◆ SetRotation() [2/2]

◆ Show()

Property Documentation

◆ CellOffset

◆ IsHex

◆ IsXY

◆ WorldCenter