Class NavLink

Abstract class from which all different and custom NavLinks should inherit. A NavLink is a game element facilitating teleportation between distant tiles, enhancing gameplay with seamless transitions

Inheritance

object

AxisMonoBehaviour

AxisGameObject

NavLink

NavLinkHole

NavLinkLaunch

NavLinkTeleport

Inherited Members

AxisMonoBehaviour.ContainsLabel(string)

AxisMonoBehaviour.CountChildrenWithLabel(string, bool)

AxisMonoBehaviour.ContainsLabelInChildren(string, bool)

AxisMonoBehaviour.GetSpaceBetweenColliders(AxisMonoBehaviour)

AxisMonoBehaviour.GetSpaceBetweenCollidersHorizontally(AxisMonoBehaviour)

AxisMonoBehaviour.PauseGame()

AxisMonoBehaviour.SetActiveByName(string)

AxisMonoBehaviour.ResumeGame()

AxisMonoBehaviour.GameTimeScaleSet(float)

AxisMonoBehaviour.transform

AxisMonoBehaviour.gameObject

AxisMonoBehaviour.collider

AxisMonoBehaviour.Origin

AxisMonoBehaviour.OnTransformChildrenChanged()

Namespace: Axis.Navigation

Assembly: cs.temp.dll.dll

Syntax

public abstract class NavLink : AxisGameObject

Fields

IsActionRequired

Does this link requires agent input to enter? If not, only walking over tiles activates already.

Declaration

public bool IsActionRequired

Field Value

Type	Description
bool

OnLink

Events dispatched in NavLink main processes

Declaration

public LinkEvents OnLink

Field Value

Type	Description
LinkEvents

Out

The other link connected to this one

Declaration

public NavLink Out

Field Value

Type	Description
NavLink

SnapOnEnter

Does the entering link animation forces transform to snap to the center of the link?

Declaration

public bool SnapOnEnter

Field Value

Type	Description
bool

SnapOnExit

Does the landing link animation forces transform to snap to the other link center?

Declaration

public bool SnapOnExit

Field Value

Type	Description
bool

TileRendererSetup

Setup for rendering tiles where this NavLink is at

Declaration

public SetupTileRenderer TileRendererSetup

Field Value

Type	Description
SetupTileRenderer

Properties

CurrentMatrix

The current NavmeshMatrix this NavLink is in

Declaration

public NavmeshMatrix CurrentMatrix { get; }

Property Value

Type	Description
NavmeshMatrix

Methods

FindAllAt(NavmeshMatrix)

Declaration

public static List<NavLink> FindAllAt(NavmeshMatrix matrix)

Parameters

Type	Name	Description
NavmeshMatrix	matrix

Returns

Type	Description
System.Collections.Generic.List<T><NavLink>

FindAllWithTagAt(string, NavmeshMatrix)

Declaration

public static List<NavLink> FindAllWithTagAt(string tag, NavmeshMatrix matrix)

Parameters

Type	Name	Description
string	tag
NavmeshMatrix	matrix

Returns

Type	Description
System.Collections.Generic.List<T><NavLink>

FindAt(string, NavmeshMatrix)

Declaration

public static NavLink FindAt(string name, NavmeshMatrix matrix)

Parameters

Type	Name	Description
string	name
NavmeshMatrix	matrix

Returns

Type	Description
NavLink

FindWithTagAt(string, NavmeshMatrix)

Declaration

public static NavLink FindWithTagAt(string tag, NavmeshMatrix matrix)

Parameters

Type	Name	Description
string	tag
NavmeshMatrix	matrix

Returns

Type	Description
NavLink

GetTile()

Gets the center single tile this NavLink is in

Declaration

public Tile GetTile()

Returns

Type	Description
Tile

NearestLinkTile(Vector3)

Among all tiles this link is covering, get the nearest to the given point

Declaration

public Tile NearestLinkTile(Vector3 position)

Parameters

Type	Name	Description
Vector3	position	Point to check

Returns

Type	Description
Tile	The nearest tile