Detailed Description

common interface for objects that handle grid links
made for convenience so road and map linking is interchangable

Inheritance diagram for CityBuilderCore.IGridLinker:

Public Member Functions
void	RegisterLink (IGridLink link, object tag)
	adds a link to the linker

void	DeregisterLink (IGridLink link, object tag)
	removes a link from the linker

IEnumerable< IGridLink >	GetLinks (Vector2Int start, object tag)
	retrieves all links starting at a specific point

IGridLink	GetLink (Vector2Int start, Vector2Int end, object tag)
	retrieves a link connecting two specific points if one exists

Member Function Documentation

void CityBuilderCore.IGridLinker.DeregisterLink	(	IGridLink	link,
		object	tag )

removes a link from the linker

Parameters

link	the link to be removed
tag	additional information, for example the Road when the link should be removed to a specific road network

IGridLink CityBuilderCore.IGridLinker.GetLink	(	Vector2Int	start,
		Vector2Int	end,
		object	tag )

retrieves a link connecting two specific points if one exists

Parameters

start	start point of the potential link
end	end point of the potential link
tag	additional parameter

IEnumerable< IGridLink > CityBuilderCore.IGridLinker.GetLinks	(	Vector2Int	start,
		object	tag )

retrieves all links starting at a specific point

Parameters

start	the point at which to look for lniks
tag	additional parameter

void CityBuilderCore.IGridLinker.RegisterLink	(	IGridLink	link,
		object	tag )

adds a link to the linker

Parameters

link	the link to be added
tag	additional information, for example the Road when the link should be added to a specific road network