Documentation
TebexDiscordYouTubeGitHub
  • Introduction
  • FIVEM FREE RESOURCES
    • BDTK
      • Guides
      • API
        • Bridges
          • Framework
          • Notifications
          • DrawText UI
        • Modules
          • Appearance
          • Buckets
          • Callbacks
          • Commands
          • Cooldowns
          • Debugging
          • Entities
          • Environment
          • Geometry
    • BDSC
      • Guides
        • What Are Plugins?
        • Making Your First Plugin
      • API
        • Player
        • Manager
        • Utility
    • boii_utils
      • Installation
      • Configuration
      • Modules
      • API
        • Callbacks
        • Characters
        • Commands
        • Cooldowns
        • Debugging
        • Entities
        • Environment
        • Framework Bridge
        • Geometry
        • Items
        • Keys
        • Licences
        • Maths
        • Methods
        • Player
        • Requests
        • Strings
        • Tables
        • Timestamps
        • UI Bridges
        • Vehicles
        • Version
        • XP
        • UI Elements
  • FIVEM PAID RESOURCES
    • Page 2
Powered by GitBook
On this page
  • get_user
  • create_player
  • register_hook
  • has_hook_run
  • clear_hooks
  • get_player
  • get_players
  • add_player
  • remove_player
  • clear_players
  • save_all_players
  1. FIVEM FREE RESOURCES
  2. BDSC
  3. API

Manager

get_user

Returns the boii_utils user object for a player. Contains the users unique_id and rank.

Parameters

  • source: number

Returns

  • table

bdsc.get_user(source)
exports.bdsc:get_user(source)

create_player

Creates and registers a new player object.

Parameters

  • source: number

Returns

  • table|nil

bdsc.create_player(source)
exports.bdsc:create_player(source)

register_hook

Registers a new plugin hook that runs during player creation. Used for injecting additional logic via external scripts into the main player object.

Parameters

  • name: string

  • fn: function

  • priority?: number

bdsc.register_hook(name, fn, priority)
exports.bdsc:register_hook(name, fn, priority)

has_hook_run

Checks whether a plugin hook has already run.

Parameters

  • name: string

Returns

  • boolean

bdsc.has_hook_run(name)
exports.bdsc:has_hook_run(name)

clear_hooks

Clears all plugin hook registrations and their execution state.

bdsc.clear_hooks()
exports.bdsc:clear_hooks()

get_player

Gets a player object from the registry.

Parameters

  • source: number

Returns

  • table|nil

bdsc.get_player(source)
exports.bdsc:get_player(source)

get_players

Returns a list of all registered players.

Returns

  • table|nil

bdsc.get_players()
exports.bdsc:get_players()

add_player

Triggered internally by create_player.


remove_player

Removes a player from the registry.

Parameters

  • source: number

Returns

  • boolean

bdsc.remove_player(source)
exports.bdsc:remove_player(source)

clear_players

Removes all players from the registry.

Returns

  • boolean

bdsc.clear_players()
exports.bdsc:clear_players()

save_all_players

Saves all players and their extensions.

Returns

  • boolean

bdsc.save_all_players()
exports.bdsc:save_all_players()

Last updated 10 hours ago