Module sv_bucket

Bucket System

Functions

GetPlayerInstance (src) GetPlayerInstance function.
GetEntityInstance (entity) GetEntityInstance function.
SetPlayerInstance (src, instanceID) SetPlayerInstance function.
SetEntityInstance (entity, instanceID) SetEntityInstance function.
GetPlayersInInstance (instanceID) GetPlayersInInstance function.

Commands

CheckInstance CheckInstance command.


Functions

GetPlayerInstance (src)
GetPlayerInstance function. This function gets the instance of a player.

Parameters:

  • src The player to get the instance from. number

Returns:

    number

Usage:

    local instanceID = exports.jones_util:GetPlayerInstance(src)
GetEntityInstance (entity)
GetEntityInstance function. This function gets the instance of a entity.

Parameters:

  • entity The entity to get the instance from. number

Returns:

    number

Usage:

    local instanceID = exports.jones_util:GetEntityInstance(entity)
SetPlayerInstance (src, instanceID)
SetPlayerInstance function. This function sets the instance of a player.

Parameters:

  • src The player to set the instance to. number
  • instanceID The instance ID. number

Usage:

    exports.jones_util:SetPlayerInstance(src, 1)
SetEntityInstance (entity, instanceID)
SetEntityInstance function. This function sets the instance of a entity.

Parameters:

  • entity The entity to set the instance to. number
  • instanceID The instance ID. number

Usage:

    exports.jones_util:SetEntityInstance(entity, 1)
GetPlayersInInstance (instanceID)
GetPlayersInInstance function. This function gets all players in a instance.

Parameters:

  • instanceID The instance ID. number

Returns:

    table

Usage:

    local players = exports.jones_util:GetPlayersInInstance(1)

Commands

CheckInstance
CheckInstance command. This command checks the current instance of the player.

param:

  • src The player to check the instance from. number
  • args The command arguments. table
  • raw The raw command. string

Usage:

    /CheckInstance
generated by LDoc 1.5.0 Last updated 2024-05-13 19:05:24