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.

General

togglePlacementMode

Toggles the tape and cone placement mode.

Example Usage

exports.div_tape:togglePlacementMode()

toggleDeletionMode

Toggles the tape and cone deletion mode.

Example Usage

exports.div_tape:toggleDeletionMode()

isCreationActive

Checks if creation mode is active.

Returned Data

PropTypeDefault
isActive
boolean
-

Example Usage

local isActive = exports.div_tape:isCreationActive()

isDeletionActive

Checks if deletion mode is active.

Returned Data

PropTypeDefault
isActive
boolean
-

Example Usage

local isActive = exports.div_tape:isDeletionActive()

isContinuousActive

Checks if continuous mode is active.

Returned Data

PropTypeDefault
isActive
boolean
-

Example Usage

local isActive = exports.div_tape:isContinuousActive()

getCurrentPlacementMode

Checks if continuous mode is active.

Returned Data

PropTypeDefault
placementMode
tape | cone
-

Example Usage

local placementMode = exports.div_tape:getCurrentPlacementMode()

getClosestTape

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

Arguments

PropTypeDefault
coords?
vector3
-

Returned Data

PropTypeDefault
tapeId
number
-

Example Usage

local closestTape = exports.div_tape:getClosestTape(vector3(0, 0, 0))

deleteTape

Deletes a tape if valid tapeId is specified.

Arguments

PropTypeDefault
tapeId
number
-

Example Usage

exports.div_tape:deleteTape()