Marker
A marker pack marker.
note
A majority of these fields simply reflect the marker attributes (any without a description). More information on attributes can be found in the attributes section.
Fields
| Field | Type | Description |
|---|---|---|
Alpha | number | |
AutoTrigger | boolean | |
BehaviorFiltered | boolean | [READ-ONLY] Indicates if the marker is actively filtered by a behavior. |
Behaviors | IBehavior[] | A list of behaviors attached to the marker. |
CanFade | boolean | |
Category | Category | [READ-ONLY] The parent category of the marker |
CullDirection | integer | |
DistanceToPlayer | number | |
DrawOrder | number | |
FadeFar | number | |
FadeNear | number | |
Focused | boolean | |
Guid | any | |
HeightOffset | number | |
InGameVisibility | any | |
InvertBehavior | boolean | |
MapDisplaySize | number | |
MapId | integer | [READ-ONLY] |
MapVisibility | boolean | |
MaxSize | number | |
MiniMapVisibility | boolean | |
MinSize | number | |
Position | Vector3 | |
ResetLength | number | |
RotationXyz | Vector3 | |
ScaleOnMapWithZoom | boolean | |
Size | number | |
Texture | Texture | |
Tint | Color | |
TipDescription | string | |
TipName | string | |
TriggerRange | number |
Functions
| Function | Description |
|---|---|
Focus | Focuses the marker. |
Unfocus | Unfocuses the marker. |
Interact | Triggers the marker. |
SetPos(x, y, z) | Sets the x,y,z position of the marker. |
SetPos(vector) | Sets the x,y,z position of the marker. |
SetPosX | Set the X coordinate of the marker. |
SetPosY | Set the Y coordinate of the marker. |
SetPosZ | Set the Z coordinate of the marker. |
SetRot(x, y, z) | Set the rotation of the marker (in radians). |
SetRot(vector) | Set the rotation of the marker (in radians). |
SetRotX | Set the x rotation of the marker (in radians). |
SetRotY | Set the y rotation of the marker (in radians). |
SetRotZ | Set the z rotation of the marker (in radians). |
Remove | Removes the marker. |
SetTexture(texturePath) | Sets the texture of the marker. |
SetTexture(textureId) | Sets the texture of the marker using an asset from the public CDN. |
GetBehavior | Returns any matching behavior by its type name. |
Marker:Focus()
Focuses the marker.
Usage
script.lua
some_marker:Focus()
Marker:Unfocus()
Unfocuses the marker.
Usage
script.lua
some_marker:Unfocus()
Marker:Interact(isAutoTriggered)
Triggers the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
isAutoTriggered | boolean | Indicates if the trigger was from an auto trigger or if it was manually triggered. |
Usage
script.lua
some_marker:Interact(true)
Marker:SetPos(x, y, z)
Sets the x,y,z position of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
x | number | The X coordinate to set the marker to. |
y | number | The Y coordinate to set the marker to. |
z | number | The Z coordinate to set the marker to. |
Usage
script.lua
some_marker:SetPos(0, 0, 0)
Marker:SetPos(vector)
Sets the x,y,z position of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
vector | Vector3 | The position to set the marker to. |
Usage
script.lua
some_marker:SetPos(a_vector_3)
Marker:SetPosX(x)
Set the X coordinate of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
x | number | The X coordinate to set the marker to. |
Usage
script.lua
some_marker:SetPosX(0)
Marker:SetPosY(y)
Set the Y coordinate of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
y | number | The Y coordinate to set the marker to. |
Usage
script.lua
some_marker:SetPosY(0)
Marker:SetPosZ(z)
Set the Z coordinate of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
z | number | The Z coordinate to set the marker to. |
Usage
script.lua
some_marker:SetPosZ(0)
Marker:SetRot(x, y, z)
Set the rotation of the marker (in radians).
Parameters
| Parameter | Type | Description |
|---|---|---|
x | number | The X rotation to set the marker to. |
y | number | The Y rotation to set the marker to. |
z | number | The Z rotation to set the marker to. |
Usage
script.lua
some_marker:SetRot(0, 0, 0)
Marker:SetRot(vector)
Set the rotation of the marker (in radians).
Parameters
| Parameter | Type | Description |
|---|---|---|
vector | Vector3 | The rotation to set the marker to. |
Usage
script.lua
some_marker:SetRot(a_vector_3)
Marker:SetRotX(x)
Set the x rotation of the marker (in radians).
Parameters
| Parameter | Type | Description |
|---|---|---|
x | number | The X rotation to set the marker to. |
Usage
script.lua
some_marker:SetRotX(0)
Marker:SetRotY(y)
Set the y rotation of the marker (in radians).
Parameters
| Parameter | Type | Description |
|---|---|---|
y | number | The Y rotation to set the marker to. |
Usage
script.lua
some_marker:SetRotY(0)
Marker:SetRotZ(z)
Set the z rotation of the marker (in radians).
Parameters
| Parameter | Type | Description |
|---|---|---|
z | number | The Z rotation to set the marker to. |
Usage
script.lua
some_marker:SetRotZ(0)
Marker:Remove()
Removes the marker.
Usage
script.lua
some_marker:Remove()
Marker:SetTexture(texturePath)
Sets the texture of the marker.
Parameters
| Parameter | Type | Description |
|---|---|---|
texturePath | string | The relative path to the texture (relative to the root of the marker pack). |
Usage
script.lua
some_marker:SetTexture("path/to/texture")
Marker:SetTexture(textureId)
Sets the texture of the marker using an asset from the public CDN.
Parameters
| Parameter | Type | Description |
|---|---|---|
textureId | integer | The relative path to the texture (relative to the root of the marker pack). |
Usage
script.lua
-- TODO: use a real texture id
some_marker:SetTexture(123456789)
Marker:GetBehavior(behaviorName)
Returns any matching behavior by its type name.
Parameters
| Parameter | Type | Description |
|---|---|---|
behaviorName | string | The name of the behavior type. |
Returns | IBehavior
The behavior if found, otherwise nil.
Usage
script.lua
some_marker:GetBehavior("some_behavior")