FMAR.Internal.PointsOfInterest.PointOfInterestManager Class Reference

Manages the creation and destruction of points of interest, as well as the drawing of breadcrumb paths. More...

Inheritance diagram for FMAR.Internal.PointsOfInterest.PointOfInterestManager:

Public Member Functions
override void	OnNetworkSpawn ()
	Called when the network object is spawned.
void	OnPoiEnabledDisable ()
	Called when the points of interest are enabled or disabled.
void	CreatePoiServerRpc (Vector3 position, string name, PointOfInterest.Shape shape, string description, int icon, Color color)
	Create a point of interest on the server.
void	CreateBreadcrumb (ulong playerNetworkObjectId, Vector3 location)
	Create a breadcrumb on the server.
void	RevisePoiNameDescriptionServerRpc (ulong poiNetworkObjectId, string revisedName, string revisedDescription)
	Revise the name and description of a point of interest on the server.
void	DestroyPoiServerRpc (ulong poiNetworkObjectId)
	Destroy a point of interest on the server.
void	ToggleBreadcrumbsVisibility ()
	Toggle the visibility of the breadcrumbs.
void	ClearAllBreadcrumbs ()
	Clear all breadcrumbs from the world.

Static Public Member Functions
static void	AddBarrier (Barrier barrier)
	Add a barrier to the world.
static void	RemoveBarrier (Barrier barrier)
	Remove a barrier from the world.

Static Public Attributes
static List< PointOfInterest >	pois = new()
	A list of all points of interest in the world.
static List< Barrier >	barriers = new()
	A list of all barriers in the world.
static Action< bool >	OnShowBreadcrumbsChanged
	An event that is invoked when the breadcrumbs are shown or hidden.

Properties
static PointOfInterestManager	Instance [get]
static List< Sprite >	IconLibrary [get]
	The icon library. Points of interest use unique ids for each icon for network compatibility, which refer to an index in this list.
static bool	ShowBreadcrumbs [get]
	Whether or not to show the breadcrumbs.

Events
static Action	OnPoisChanged

Detailed Description

Manages the creation and destruction of points of interest, as well as the drawing of breadcrumb paths.

Member Function Documentation

AddBarrier()

static void FMAR.Internal.PointsOfInterest.PointOfInterestManager.AddBarrier ( Barrier barrier )

inlinestatic

Add a barrier to the world.

Parameters

barrier

The barrier to add to the world.

ClearAllBreadcrumbs()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.ClearAllBreadcrumbs ( )

inline

Clear all breadcrumbs from the world.

CreateBreadcrumb()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.CreateBreadcrumb ( ulong playerNetworkObjectId, Vector3 location )

inline

Create a breadcrumb on the server.

Parameters

playerNetworkObjectId	The network object ID of the player.
location	The location of the breadcrumb.

CreatePoiServerRpc()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.CreatePoiServerRpc ( Vector3 position, string name, PointOfInterest.Shape shape, string description, int icon, Color color )

inline

Create a point of interest on the server.

Parameters

position	The position of the point of interest.
name	The name of the point of interest.
shape	The shape of the point of interest.
description	The description of the point of interest.
icon	The icon of the point of interest.
color	The color of the point of interest.

DestroyPoiServerRpc()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.DestroyPoiServerRpc ( ulong poiNetworkObjectId )

inline

Destroy a point of interest on the server.

Parameters

poiNetworkObjectId

The network object ID of the point of interest.

OnNetworkSpawn()

override void FMAR.Internal.PointsOfInterest.PointOfInterestManager.OnNetworkSpawn ( )

inline

Called when the network object is spawned.

OnPoiEnabledDisable()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.OnPoiEnabledDisable ( )

inline

Called when the points of interest are enabled or disabled.

RemoveBarrier()

static void FMAR.Internal.PointsOfInterest.PointOfInterestManager.RemoveBarrier ( Barrier barrier )

inlinestatic

Remove a barrier from the world.

Parameters

barrier

The barrier to remove from the world.

RevisePoiNameDescriptionServerRpc()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.RevisePoiNameDescriptionServerRpc ( ulong poiNetworkObjectId, string revisedName, string revisedDescription )

inline

Revise the name and description of a point of interest on the server.

Parameters

poiNetworkObjectId	The network object ID of the point of interest.
revisedName	The new name of the point of interest.
revisedDescription	The new description of the point of interest.

ToggleBreadcrumbsVisibility()

void FMAR.Internal.PointsOfInterest.PointOfInterestManager.ToggleBreadcrumbsVisibility ( )

inline

Toggle the visibility of the breadcrumbs.

Member Data Documentation

barriers

List<Barrier> FMAR.Internal.PointsOfInterest.PointOfInterestManager.barriers = new()

static

A list of all barriers in the world.

OnShowBreadcrumbsChanged

Action<bool> FMAR.Internal.PointsOfInterest.PointOfInterestManager.OnShowBreadcrumbsChanged

static

An event that is invoked when the breadcrumbs are shown or hidden.

pois

List<PointOfInterest> FMAR.Internal.PointsOfInterest.PointOfInterestManager.pois = new()

static

A list of all points of interest in the world.

Property Documentation

IconLibrary

List<Sprite> FMAR.Internal.PointsOfInterest.PointOfInterestManager.IconLibrary

staticget

The icon library. Points of interest use unique ids for each icon for network compatibility, which refer to an index in this list.

Instance

PointOfInterestManager FMAR.Internal.PointsOfInterest.PointOfInterestManager.Instance

staticget

ShowBreadcrumbs

bool FMAR.Internal.PointsOfInterest.PointOfInterestManager.ShowBreadcrumbs

staticget

Whether or not to show the breadcrumbs.

Event Documentation

OnPoisChanged

Action FMAR.Internal.PointsOfInterest.PointOfInterestManager.OnPoisChanged

static

---

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

• /github/workspace/Packages/FMAR/Internal/PointsOfInterest/Runtime/Scripts/PointOfInterestManager.cs