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
Inherited Members
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
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 |