Skip to main content

Pack

Pack provides the ability to execute scripts and create markers.

Functions

FunctionDescription
RequireExecutes the Lua file specified.
CreateMarkerCreates a new marker within the marker pack.


Pack:Require(path)

Executes the Lua file specified.

Parameters

ParameterTypeDescription
pathstringThe relative path to the script. Must be relative to the root of the marker pack. .lua at the end is optional.

Usage

script.lua
Pack:Require("path/to/script")


Pack:CreateMarker(attributes)

Creates a new marker within the marker pack.

Parameters

ParameterTypeDescription
attributestableThe attributes of the marker.

Usage

script.lua
local attributes = {
xpos = 0,
ypos = 0,
zpos = 0,
iconFile = "path/to/icon.png",
}

local newMarker = Pack:CreateMarker(attributes)