FMAR.Internal.PointsOfInterest.Breadcrumb Class Reference

Breadcrumb object, acts as a specialized point of interest that is automatically placed at the user's location over time, to help them find their way back. More...

Inheritance diagram for FMAR.Internal.PointsOfInterest.Breadcrumb:

Public Member Functions
Breadcrumb	Init (ulong playerNetworkObjectId)
	Initialize the breadcrumb object.
Public Member Functions inherited from FMAR.Internal.PointsOfInterest.PointOfInterest
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 ()

Protected Member Functions
override void	OnEnable ()
override void	OnDisable ()
override void	OnNetShapeChanged (Shape previous, Shape current)
	Called when the network shape changes. (sphere, box, breadcrumb)
override void	OnNetIconChanged (int previous, int current)
	Called when the network icon changes.
Protected Member Functions inherited from FMAR.Internal.PointsOfInterest.PointOfInterest

Properties
ulong	PlayerNetworkObjectId [get]
DateTime	Timestamp [get]
Properties inherited from FMAR.Internal.PointsOfInterest.PointOfInterest
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

Additional Inherited Members
Public Types inherited from FMAR.Internal.PointsOfInterest.PointOfInterest
enum	Shape { Cube , Sphere , Breadcrumb }
	The shape of the point of interest. (cube, sphere, breadcrumb) More...
Public Attributes inherited from FMAR.Internal.PointsOfInterest.PointOfInterest
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 Attributes inherited from FMAR.Internal.PointsOfInterest.PointOfInterest
SpriteRenderer	spriteRend

Detailed Description

Breadcrumb object, acts as a specialized point of interest that is automatically placed at the user's location over time, to help them find their way back.

Member Function Documentation

Init()

Breadcrumb FMAR.Internal.PointsOfInterest.Breadcrumb.Init ( ulong playerNetworkObjectId )

inline

Initialize the breadcrumb object.

Parameters

playerNetworkObjectId

The network object id of the player.

Returns

OnDisable()

override void FMAR.Internal.PointsOfInterest.Breadcrumb.OnDisable ( )

inlineprotectedvirtual

Reimplemented from FMAR.Internal.PointsOfInterest.PointOfInterest.

OnEnable()

override void FMAR.Internal.PointsOfInterest.Breadcrumb.OnEnable ( )

inlineprotectedvirtual

Reimplemented from FMAR.Internal.PointsOfInterest.PointOfInterest.

OnNetIconChanged()

override void FMAR.Internal.PointsOfInterest.Breadcrumb.OnNetIconChanged ( int previous, int current )

inlineprotectedvirtual

Called when the network icon changes.

Parameters

previous	The previous icon.
current	The current icon.

Reimplemented from FMAR.Internal.PointsOfInterest.PointOfInterest.

OnNetShapeChanged()

override void FMAR.Internal.PointsOfInterest.Breadcrumb.OnNetShapeChanged ( Shape previous, Shape current )

inlineprotectedvirtual

Called when the network shape changes. (sphere, box, breadcrumb)

Parameters

previous	The previous shape.
current	The current shape.

Reimplemented from FMAR.Internal.PointsOfInterest.PointOfInterest.

Property Documentation

PlayerNetworkObjectId

ulong FMAR.Internal.PointsOfInterest.Breadcrumb.PlayerNetworkObjectId

get

Timestamp

DateTime FMAR.Internal.PointsOfInterest.Breadcrumb.Timestamp

get

---

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

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