FMAR.Internal.PointsOfInterest.PointOfInterest Class Reference

Point of interest object, is visible within the world and also on the map. This is the object that lives in the world and defines the location of the POI, and provides a physical representation of the POI in world space. More...

Inheritance diagram for FMAR.Internal.PointsOfInterest.PointOfInterest:

Public Types
enum	Shape { Cube , Sphere , Breadcrumb }
	The shape of the point of interest. (cube, sphere, breadcrumb) More...

Public Member Functions
PointOfInterest	Init (string name, Shape shape, string description, int icon, Color color, int id, float scopeRadius)
	Initialize the point of interest.
void	Revise (string name, string description)
	Revise the point of interest, changing the name and description.
override void	OnNetworkSpawn ()

Public Attributes
Action	onRemove
	Action to invoke when the point of interest is removed.
Action< PointOfInterest >	onRemoveCallback
	Action to invoke when the point of interest is removed, with the point of interest as the parameter.

Protected Member Functions
virtual void	OnEnable ()
virtual void	OnDisable ()
virtual void	OnNetShapeChanged (Shape previous, Shape current)
virtual void	OnNetIconChanged (int previous, int current)
	Called when the icon is changed over the network.

Protected Attributes
SpriteRenderer	spriteRend

Properties
int	Icon [get]
	The icon to represent the point of interest. Allows points of interest to have unique meanings at a glance.
int	Identifier [get]
	The POI identifier, a unique ID to help differentiate POIs from one another.
string	PoiName [get]
	The name of the point of interest.
string	PoiDescription [get]
	User-entered text describing any additional information about the POI.
Color	PoiColor [get]
	The color of the point of interest. Randomized by default.
float	PoiScopeRadius [get]
	The scope radius of the point of interest.
List< InspectorRow >	InspectorRows [get]
	Inspector widgets for the point of interest.
Properties inherited from FMAR.Internal.Inspectables.IInspectable

Detailed Description

Point of interest object, is visible within the world and also on the map. This is the object that lives in the world and defines the location of the POI, and provides a physical representation of the POI in world space.

Member Enumeration Documentation

Shape

enum FMAR.Internal.PointsOfInterest.PointOfInterest.Shape

The shape of the point of interest. (cube, sphere, breadcrumb)

Enumerator
Cube
Sphere
Breadcrumb

Member Function Documentation

Init()

PointOfInterest FMAR.Internal.PointsOfInterest.PointOfInterest.Init ( string name, Shape shape, string description, int icon, Color color, int id, float scopeRadius )

inline

Initialize the point of interest.

Parameters

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.
id	The identifier of the point of interest.
scopeRadius	The scope radius of the point of interest.

OnDisable()

virtual void FMAR.Internal.PointsOfInterest.PointOfInterest.OnDisable ( )

inlineprotectedvirtual

Reimplemented in FMAR.Internal.PointsOfInterest.Breadcrumb.

OnEnable()

virtual void FMAR.Internal.PointsOfInterest.PointOfInterest.OnEnable ( )

inlineprotectedvirtual

Reimplemented in FMAR.Internal.PointsOfInterest.Breadcrumb.

OnNetIconChanged()

virtual void FMAR.Internal.PointsOfInterest.PointOfInterest.OnNetIconChanged ( int previous, int current )

inlineprotectedvirtual

Called when the icon is changed over the network.

Parameters

previous	The previous icon.
current	The current icon.

Reimplemented in FMAR.Internal.PointsOfInterest.Breadcrumb.

OnNetShapeChanged()

virtual void FMAR.Internal.PointsOfInterest.PointOfInterest.OnNetShapeChanged ( Shape previous, Shape current )

inlineprotectedvirtual

Reimplemented in FMAR.Internal.PointsOfInterest.Breadcrumb.

OnNetworkSpawn()

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

inline

Revise()

void FMAR.Internal.PointsOfInterest.PointOfInterest.Revise ( string name, string description )

inline

Revise the point of interest, changing the name and description.

Parameters

name	The new name of the point of interest.
description	The new description of the point of interest.

Member Data Documentation

onRemove

Action FMAR.Internal.PointsOfInterest.PointOfInterest.onRemove

Action to invoke when the point of interest is removed.

onRemoveCallback

Action<PointOfInterest> FMAR.Internal.PointsOfInterest.PointOfInterest.onRemoveCallback

Action to invoke when the point of interest is removed, with the point of interest as the parameter.

spriteRend

SpriteRenderer FMAR.Internal.PointsOfInterest.PointOfInterest.spriteRend

protected

Property Documentation

Icon

int FMAR.Internal.PointsOfInterest.PointOfInterest.Icon

get

The icon to represent the point of interest. Allows points of interest to have unique meanings at a glance.

Identifier

int FMAR.Internal.PointsOfInterest.PointOfInterest.Identifier

get

The POI identifier, a unique ID to help differentiate POIs from one another.

InspectorRows

List<InspectorRow> FMAR.Internal.PointsOfInterest.PointOfInterest.InspectorRows

get

Inspector widgets for the point of interest.

Implements FMAR.Internal.Inspectables.IInspectable.

PoiColor

Color FMAR.Internal.PointsOfInterest.PointOfInterest.PoiColor

get

The color of the point of interest. Randomized by default.

PoiDescription

string FMAR.Internal.PointsOfInterest.PointOfInterest.PoiDescription

get

User-entered text describing any additional information about the POI.

PoiName

string FMAR.Internal.PointsOfInterest.PointOfInterest.PoiName

get

The name of the point of interest.

PoiScopeRadius

float FMAR.Internal.PointsOfInterest.PointOfInterest.PoiScopeRadius

get

The scope radius of the point of interest.

---

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

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