Markers
server
This API is used to send markers to the Gamebeast platform.
local Gamebeast = require(game:GetService("ReplicatedStorage"):WaitForChild("Gamebeast"))
local GamebeastMarkers = Gamebeast:GetService("Markers")
:SendMarker(markerType, value, position)
→ void
This method sends a marker with the specified value to Gamebeast.
markerType
string
The name of the marker.
value
number | {[string] : any}
The value of the marker.
position
Vector3?
The optional marker world position for heatmap visualization.
Usage
GamebeastMarkers:SendMarker("Coins", {Amount = 50, FoundIn = "Lobby"})
-- Single value example:
GamebeastMarkers:SendMarker("Coins", 50)
-- With position
local Character = game:GetService("Players").LocalPlayer.Character
GamebeastMarkers:SendMarker("Coins", 50, Character.PrimaryPart.Position)
:SendPlayerMarker(player, markerType, value, position)
→ void
This function sends a marker associated with a specific player to Gamebeast.
player
Player
The player instance associated with the marker.
markerType
string
The name of the marker.
value
number | {[string] : any}
The value of the marker.
position
Vector3?
The optional marker world position for heatmap visualization.
Usage
local Player = game:GetService("Players").Player1
GamebeastMarkers:SendPlayerMarker(Player, "Coins", {Amount = 50, FoundIn = "Lobby"})
-- Single value example:
GamebeastMarkers:SendPlayerMarker(Player, "Coins", 50)
-- With position
GamebeastMarkers:SendPlayerMarker(Player, "Coins", 50, Player.Character.PrimaryPart.Position)