Infohazard.HyperNav 2.3.0
A pathfinding and avoidance solution for volumetric and omnidirectional navigation.
Loading...
Searching...
No Matches
Infohazard.HyperNav.NavLayer Struct Reference

A single NavLayer. May have the value 0 to 31, or -1 for invalid. More...

Public Member Functions

readonly NavLayerMask AsMask ()
 Get a mask that represents this single layer. More...
 
readonly string GetName ()
 Get the name of this layer from the settings. More...
 
readonly override string ToString ()
 
readonly bool Equals (NavLayer other)
 
readonly override bool Equals (object obj)
 
readonly override int GetHashCode ()
 

Static Public Member Functions

static NavLayer Get (string name)
 Get the NavLayer corresponding to the given name in the settings. More...
 
static bool operator== (NavLayer layer1, NavLayer layer2)
 Equality check. More...
 
static bool operator!= (NavLayer layer1, NavLayer layer2)
 Inequality check. More...
 
static bool TryGet (string name, out NavLayer layer)
 Try to get the NavLayer corresponding to the given name in the settings. More...
 

Detailed Description

A single NavLayer. May have the value 0 to 31, or -1 for invalid.

Member Function Documentation

◆ AsMask()

readonly NavLayerMask Infohazard.HyperNav.NavLayer.AsMask ( )

Get a mask that represents this single layer.

Returns
A mask that represents this layer.

◆ Equals() [1/2]

readonly bool Infohazard.HyperNav.NavLayer.Equals ( NavLayer  other)

◆ Equals() [2/2]

readonly override bool Infohazard.HyperNav.NavLayer.Equals ( object  obj)

◆ Get()

static NavLayer Infohazard.HyperNav.NavLayer.Get ( string  name)
static

Get the NavLayer corresponding to the given name in the settings.

Parameters
nameThe name of the layer.
Returns
The layer with that name, or None if invalid.

◆ GetHashCode()

readonly override int Infohazard.HyperNav.NavLayer.GetHashCode ( )

◆ GetName()

readonly string Infohazard.HyperNav.NavLayer.GetName ( )

Get the name of this layer from the settings.

Returns
The name of the layer, or an empty string if it is invalid.

◆ operator!=()

static bool Infohazard.HyperNav.NavLayer.operator!= ( NavLayer  layer1,
NavLayer  layer2 
)
static

Inequality check.

◆ operator==()

static bool Infohazard.HyperNav.NavLayer.operator== ( NavLayer  layer1,
NavLayer  layer2 
)
static

Equality check.

◆ ToString()

readonly override string Infohazard.HyperNav.NavLayer.ToString ( )

◆ TryGet()

static bool Infohazard.HyperNav.NavLayer.TryGet ( string  name,
out NavLayer  layer 
)
static

Try to get the NavLayer corresponding to the given name in the settings.

Parameters
nameThe name of the layer.
layerThe layer with that name, or None if invalid.
Returns
Whether the layer exists.

The documentation for this struct was generated from the following file: