BCC Utils

This provides the ability to print every in-game event for development purpose.

BccUtils.Events:DevMode(listener)

Example Usage:

-- Client
Citizen.CreateThread(function()
    BccUtils.Events:DevMode(true, 'entities')
    --  BccUtils.Events:DevMode(true, 'network')
end)

Audio Player Documentation

• To play audio from youtube in your code! (This is not network synces, client specific)

function playsound()
    BccUtils.YtAudioPlayer.PlayAudio(embedlink , videoid, volume, looped)
end
--Filled out example
function playsound()
    BccUtils.YtAudioPlayer.PlayAudio("https://www.youtube.com/embed/TMeP3kI_2ng" , "TMeP3kI_2ng", 50, 0)
end
-- To Stop Audio
function stopaudio()
    BccUtils.YtAudioPlayer.StopAudio()
end

• Make sure you stop all audio before trying to play a new bit of audio!

Versioner Documentation

• Github Release based checks How to use Github Releases

Create a Release and tag with the version number

Correct: 1.0.0

Wrong: v1.1.0

Add the following contents to your lua server

local repo = 'https://github.com/BryceCanyonCounty/bcc-anticheat'
BccUtils.Versioner.checkRelease(GetCurrentResourceName(), repo)

• Github File Based Checks

Create a file called version with the following contents

<1.3>
- More awesome updates
<1.1>
- Some awesome updates
<1.0>
- My first Update

Add the following contents to your lua server

local repo = 'https://github.com/BryceCanyonCounty/bcc-anticheat'
BccUtils.Versioner.checkFile(GetCurrentResourceName(), repo)

Discord Webhooks

This API allows you to easily add Discord webhooks messages to your scripts.

Send One Time Message

-- (webhookurl, webhookname, webhookavatar, name, description, embeds)
BccUtils.Discord.sendMessage('webhookurl', 'My Script', 'https://cdn2.iconfinder.com/data/icons/frosted-glass/256/Danger.png', 'user123', 'this user is awesome')

Create Discord Re-usable instance

-- (webhookurl, webhookname, webhookavatar)
local discord = BccUtils.Discord.setup('webhookurl', 'My Script', 'https://cdn2.iconfinder.com/data/icons/frosted-glass/256/Danger.png')
-- (name, description, embeds)
discord:sendMessage('user123', 'this user is awesome')
discord:sendMessage('user456', 'this user is ALSO awesome')
discord:sendMessage('user789', 'this user kinda really awesome', {
    {
        color = 11342935,
        title = 'Embed Item 1',
        description = 'Items awesome description?'
    },
    {
        color = 11342935,
        title = 'Embed Item 2',
        description = 'Item 2 awesome description!'
    },
})

Custom Embeds

Add custom embeds

-- (webhookurl, webhookname, webhookavatar, name, description, embeds)
BccUtils.Discord.sendMessage('webhookurl', 'My Script', 'https://cdn2.iconfinder.com/data/icons/frosted-glass/256/Danger.png', 'user123', 'this user is awesome'{
  {
    {
      color = 11342935,
      title = 'some times',
      description = 'awesomesauce'
    },
   {
      color = 11342935,
      title = 'some other time',
      description = 'awesomesauce'
    },
  }
})

Misc API

DrawText3D

BccUtils.Misc.DrawText3D(x, y, z, 'your text')

Distance Check for an entity

-- This will detect the distance between the entity and the x,y,z coords and when you are within the set dist it will break the loop
BccUtils.Misc.DistanceCheckEntity(x, y, z, entity, dist, usez)

Set GPS Waypoin

--This will place a gps waypoint on the players map to the coords set
BccUtils.Misc.SetGps(x, y, z)

Remove GPS Waypoint

BccUtils.Misc.RemoveGps()