Logo

DIVERSITY

Documentation

Exports

Client Exports

This section lists all available exports, detailing each function's purpose, arguments, and return values to help you integrate with the resource effectively.

togglePlacementMode

Toggles the tape and cone placement mode.

client.lua
exports['div_tape']:togglePlacementMode()

toggleDeletionMode

Toggles the tape and cone deletion mode.

client.lua
exports['div_tape']:toggleDeletionMode()

isCreationActive

Checks if creation mode is active.

client.lua
local isActive = exports['div_tape']:isCreationActive()
ArgumentTypeDescription
isActive
boolean
Whether creation mode is active or not.

isDeletionActive

Checks if deletion mode is active.

client.lua
local isActive = exports['div_tape']:isDeletionActive()
ArgumentTypeDescription
isActive
boolean
Whether deletion mode is active or not.

isContinuousActive

Checks if continuous mode is active.

client.lua
local isActive = exports['div_tape']:isContinuousActive()
ArgumentTypeDescription
isActive
boolean
Whether continuous mode is active or not.

getCurrentPlacementMode

Checks if continuous mode is active.

client.lua
local placementMode = exports['div_tape']:getCurrentPlacementMode()
ArgumentTypeDescription
placementMode
string
Returns either "tape" or "cone" based on the currently selected mode.

getClosestTape

Finds the closest tape to specified coords. If no coords are specified, the player's position will be used instead.

client.lua
local closestTape = exports['div_tape']:getClosestTape(coords)
ArgumentTypeDescription
coords?
vector3
The radius in which to delete tapes and cones.
Returned DataTypeDescription
tapeId
number
The tapeId of the closest tape if found.

deleteTape

Deletes a tape if valid tapeId is specified.

client.lua
exports['div_tape']:deleteTape(tapeId)
ArgumentTypeDescription
tapeId
number
A unique ID of each placed tape.

Was this page helpful?