Skip to main content

Markers Component

Component Available
ServerNo
ClientYes

The marker component manages all markers for the framework. To be able to show a marker a group needs top be registered. Distance checks are done against groups of markers to increase overall performance. All markers in a group will attempt to show when the group is within distance.

Methods​

Server​

This component has no server methods.

Client​

Marker Groups (Prefix: MarkerGroups)​

Add​
  • Parameters: groupName: string, groupCoords: Vector3, distance: number
  • Return: None
  • Description: Registers a Marker Group
Remove​
  • Parameters: groupName: string
  • Return: None
  • Description: Removes a Marker Group
Update​
  • Parameters: groupName: string, groupCoords: Vector3, groupDistance: number
  • Return: None
  • Description: Update Group Properties

Markers (Prefix: Markers)​

Add​
  • Parameters: groupName: string, markerId: string, markerCoords: vector3, markerType: int, markerScale: vector3, markerColor :table, shouldMarkerShow: function, hint: message, action: function
  • Return: None
  • Description: Registers a Marker to a Group
  • Avoid: Doing distance checks or heavy calls with shouldShow
Remove​
  • Parameters: groupName: string, id: string
  • Return: None
  • Description: Removes a Marker from a Group
Update​
  • Parameters: groupName: string, markerId: string, markerCoords: vector3, markerType: int, markerScale: vector3, markerColor :table, shouldMarkerShow: function, hint: message, action: function
  • Return: None
  • Description: Updates a Marker from a Group, will error if no marker exists