Internally stores a unsigned long to be able to toggle 512 different regions. More...

Inherits IEquatable< NavMeshRegionMask >.

Public Member Functions
	NavMeshRegionMask (ulong regionMask1, ulong regionMask2=0UL, ulong regionMask3=0UL, ulong regionMask4=0UL, ulong regionMask5=0UL, ulong regionMask6=0UL, ulong regionMask7=0UL, ulong regionMask8=0UL)
	Constructor with all flag masks. This method could change in the future if the max regions count is increased again. More...

	NavMeshRegionMask (ulong regions)
	Constructor. More...

void	Add (int region)
	Add a region id to the mask. More...

void	Clear ()
	This sets all regions to active. More...

readonly bool	Equals (in NavMeshRegionMask other)
	Equality check. More...

readonly bool	Equals (NavMeshRegionMask other)
	Equality check. More...

readonly override bool	Equals (object obj)
	Equality check. More...

readonly override int	GetHashCode ()
	Get hash code override. More...

readonly bool	IsRegionEnabled (int region)
	Check if a region is active. More...

readonly bool	IsSubset (in NavMeshRegionMask other)
	Check if the region mask is included inside the other. More...

readonly bool	IsSuperset (in NavMeshRegionMask other)
	Check is the region mask of other is included in ours. More...

readonly bool	Overlaps (in NavMeshRegionMask other)
	Returns `true` if the mask and other have at least one region in common. More...

void	Remove (int region)
	Remove a region from the mask. More...

void	Serialize (ByteStream stream, Boolean write, int blockCount=BLOCK_COUNT)
	Serialize the mask into a byte stream, used by asset serialization and deserialization. More...

void	ToggleRegion (int region, bool enabled)
	Toggle a region by id (or index). More...

readonly override string	ToString ()
	ToString override. More...

Static Public Member Functions
static NavMeshRegionMask	Combine (NavMeshRegionMask a, in NavMeshRegionMask b)
	Combine two region masks. More...

static NavMeshRegionMask	Create (int region)
	Create a NavMeshRegionMask with one region enabled. More...

static NavMeshRegionMask	Create (int[] regionList)
	Create a mask using a list of region ids. More...

static NavMeshRegionMask	Create (System.Collections.Generic.List< int > regionList)
	Create a mask using a list of region ids. More...

static void	Print (void *ptr, FramePrinter printer)
	Callback to print this component data. More...

static void	Serialize (void *ptr, FrameSerializer serializer)
	Callback to serialize this component into a snapshot of the game state. More...

Public Attributes
readonly ulong	Mask => _regions[0]
	Access to underlying bit mask. More...

Static Public Attributes
const int	BLOCK_COUNT = 8
	The number of 4 byte blocks that the mask uses. More...

const int	MAX_REGIONS = BLOCK_COUNT * BITS_PER_BLOCK
	The maximum number of regions. More...

const int	SIZE = BLOCK_COUNT * sizeof(ulong)
	The size on the struct. More...

Properties
static NavMeshRegionMask	Default `[get]`
	Default mask with all regions toggled on. More...

static NavMeshRegionMask	Empty `[get]`
	Mask that includes no area. More...

readonly bool	HasValidNoneMainRegion `[get]`
	Returns `true` if the mask includes a region other than the main area. More...

readonly bool	HasValidRegions `[get]`
	Returns `true` if the mask has at least one valid region set including the main area. More...

readonly bool	IsMainArea `[get]`
	Checks if the mask only contains the main area More...

static NavMeshRegionMask	MainArea `[get]`
	Mask that includes only the main area. More...

Detailed Description

Internally stores a unsigned long to be able to toggle 512 different regions.

When instantiating a NavMeshRegionMask, all regions are toggled off.

Use Default to create a mask with all regions toggled on.

// Toggle a region per frame
f.NavMeshRegionMask->ToggleRegion(cmd.Region, !f.NavMeshRegionMask->IsRegionEnabled(cmd.Region));
// Check if a region id is active
var isRegionActive = f.NavMeshRegionMask->IsRegionEnabled(regionId);
// Check if a NavMeshRegionMask (found on the pathfinder component) is active
var isTriangleActive = f.Unsafe.GetPointer<NavMeshPathfinder>(entity)->RegionMask.Overlaps(*f.NavMeshRegionMask);

Constructor & Destructor Documentation

◆ NavMeshRegionMask() [1/2]

Quantum.NavMeshRegionMask.NavMeshRegionMask	(	ulong	regionMask1,
		ulong	regionMask2 = `0UL`,
		ulong	regionMask3 = `0UL`,
		ulong	regionMask4 = `0UL`,
		ulong	regionMask5 = `0UL`,
		ulong	regionMask6 = `0UL`,
		ulong	regionMask7 = `0UL`,
		ulong	regionMask8 = `0UL`
	)

inline

Constructor with all flag masks. This method could change in the future if the max regions count is increased again.

Parameters

regionMask1
regionMask2
regionMask3
regionMask4
regionMask5
regionMask6
regionMask7
regionMask8

◆ NavMeshRegionMask() [2/2]

Quantum.NavMeshRegionMask.NavMeshRegionMask ( ulong regions )

inline

Constructor.

Parameters

regions Raw region mask

Member Function Documentation

◆ Combine()

static NavMeshRegionMask Quantum.NavMeshRegionMask.Combine	(	NavMeshRegionMask	a,
		in NavMeshRegionMask	b
	)

inlinestatic

Combine two region masks.

Parameters

a	A
b	B

Returns: A region must be active in both masks for be toggled on on the resulting mask.

◆ Serialize() [1/2]

static void Quantum.NavMeshRegionMask.Serialize	(	void *	ptr,
		FrameSerializer	serializer
	)

inlinestatic

Callback to serialize this component into a snapshot of the game state.

Parameters

ptr	The component pointer
serializer	The serializer

◆ Print()

static void Quantum.NavMeshRegionMask.Print	(	void *	ptr,
		FramePrinter	printer
	)

inlinestatic

Callback to print this component data.

Parameters

ptr	The component pointer
printer	The printer

◆ Create() [1/3]

static NavMeshRegionMask Quantum.NavMeshRegionMask.Create ( int region )

inlinestatic

Create a NavMeshRegionMask with one region enabled.

Parameters

region Region id to enabled.

Returns: Region Mask

◆ Create() [2/3]

static NavMeshRegionMask Quantum.NavMeshRegionMask.Create ( int[] regionList )

inlinestatic

Create a mask using a list of region ids.

Parameters

regionList List of region ids/indices

Returns: Region mask

◆ Create() [3/3]

static NavMeshRegionMask Quantum.NavMeshRegionMask.Create ( System.Collections.Generic.List< int > regionList )

inlinestatic

Create a mask using a list of region ids.

Parameters

regionList List of region ids/indices

Returns: Region mask

◆ ToggleRegion()

void Quantum.NavMeshRegionMask.ToggleRegion	(	int	region,
		bool	enabled
	)

inline

Toggle a region by id (or index).

Parameters

region	Region id (defined by the region list inside the Map)
enabled	Toggle region on or off

◆ Add()

void Quantum.NavMeshRegionMask.Add ( int region )

inline

Add a region id to the mask.

Parameters

region Region index

◆ Remove()

void Quantum.NavMeshRegionMask.Remove ( int region )

inline

Remove a region from the mask.

Parameters

region Region index

◆ IsRegionEnabled()

readonly bool Quantum.NavMeshRegionMask.IsRegionEnabled ( int region )

inline

Check if a region is active.

Parameters

region Region id (or index)

Returns: true if the region is active.

◆ IsSubset()

readonly bool Quantum.NavMeshRegionMask.IsSubset ( in NavMeshRegionMask other )

inline

Check if the region mask is included inside the other.

Parameters

other Other mask, usually the one from Frame

Returns: true if all regions are included in other

◆ IsSuperset()

readonly bool Quantum.NavMeshRegionMask.IsSuperset ( in NavMeshRegionMask other )

inline

Check is the region mask of other is included in ours.

Parameters

other Other region mask

Returns: true if all regions inside the other mask are also active in ours

◆ Overlaps()

readonly bool Quantum.NavMeshRegionMask.Overlaps ( in NavMeshRegionMask other )

inline

Returns true if the mask and other have at least one region in common.

Parameters

other Other region mask

Returns: true if masks have one region in common

◆ Clear()

void Quantum.NavMeshRegionMask.Clear ( )

inline

This sets all regions to active.

◆ Equals() [1/3]

readonly bool Quantum.NavMeshRegionMask.Equals ( NavMeshRegionMask other )

inline

Equality check.

Parameters

other Other mask

Returns: true, if both masks are equal.

◆ Equals() [2/3]

readonly bool Quantum.NavMeshRegionMask.Equals ( in NavMeshRegionMask other )

inline

Equality check.

Parameters

other Other mask

Returns: true, if both masks are equal.

◆ Equals() [3/3]

readonly override bool Quantum.NavMeshRegionMask.Equals ( object obj )

inline

Equality check.

Parameters

obj	Other object

Returns: true, is both masks are equal.

◆ GetHashCode()

readonly override int Quantum.NavMeshRegionMask.GetHashCode ( )

inline

Get hash code override.

Returns: Hashcode of this mask.

◆ ToString()

readonly override string Quantum.NavMeshRegionMask.ToString ( )

inline

ToString override.

Returns: A debug string representation of the mask.

◆ Serialize() [2/2]

void Quantum.NavMeshRegionMask.Serialize	(	ByteStream	stream,
		Boolean	write,
		int	blockCount = `BLOCK_COUNT`
	)

inline

Serialize the mask into a byte stream, used by asset serialization and deserialization.

Parameters

stream	Stream object.
write	Write or read.
blockCount	Optionally customize block count.

Member Data Documentation

◆ SIZE

const int Quantum.NavMeshRegionMask.SIZE = BLOCK_COUNT * sizeof(ulong)

static

The size on the struct.

◆ MAX_REGIONS

const int Quantum.NavMeshRegionMask.MAX_REGIONS = BLOCK_COUNT * BITS_PER_BLOCK

static

The maximum number of regions.

◆ BLOCK_COUNT

const int Quantum.NavMeshRegionMask.BLOCK_COUNT = 8

static

The number of 4 byte blocks that the mask uses.

◆ Mask

readonly ulong Quantum.NavMeshRegionMask.Mask => _regions[0]

Access to underlying bit mask.

Property Documentation

◆ Default

NavMeshRegionMask Quantum.NavMeshRegionMask.Default

staticget

Default mask with all regions toggled on.

◆ MainArea

NavMeshRegionMask Quantum.NavMeshRegionMask.MainArea

staticget

Mask that includes only the main area.

◆ Empty

NavMeshRegionMask Quantum.NavMeshRegionMask.Empty

staticget

Mask that includes no area.

◆ HasValidRegions

readonly bool Quantum.NavMeshRegionMask.HasValidRegions

get

Returns true if the mask has at least one valid region set including the main area.

◆ HasValidNoneMainRegion

readonly bool Quantum.NavMeshRegionMask.HasValidNoneMainRegion

get

Returns true if the mask includes a region other than the main area.

◆ IsMainArea

readonly bool Quantum.NavMeshRegionMask.IsMainArea

get

Checks if the mask only contains the main area

Quantum 3 3.0.9

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ NavMeshRegionMask() [1/2]

◆ NavMeshRegionMask() [2/2]

Member Function Documentation

◆ Combine()

◆ Serialize() [1/2]

◆ Print()

◆ Create() [1/3]

◆ Create() [2/3]

◆ Create() [3/3]

◆ ToggleRegion()

◆ Add()

◆ Remove()

◆ IsRegionEnabled()

◆ IsSubset()

◆ IsSuperset()

◆ Overlaps()

◆ Clear()

◆ Equals() [1/3]

◆ Equals() [2/3]

◆ Equals() [3/3]

◆ GetHashCode()

◆ ToString()

◆ Serialize() [2/2]

Member Data Documentation

◆ SIZE

◆ MAX_REGIONS

◆ BLOCK_COUNT

◆ Mask

Property Documentation

◆ Default

◆ MainArea

◆ Empty

◆ HasValidRegions

◆ HasValidNoneMainRegion

◆ IsMainArea