Dokumentation för ZeroDev Sound

Utvecklar-API för ZeroDev Sound

ZeroDev Sound har ett öppet API för andra resources: läs vad som spelas, styr ett högtalarsystem eller en bilstereo för en spelare från din egen meny, följ ändringar, placera egna högtalare och installationshallar och styr ljus från den riktiga basen. Allt här är hämtat från ZeroDev Sound 3.0.5. API-filerna är inte escrow-skyddade, så du kan läsa kontraktet själv: server/devapi.lua och client/devapi.lua.

För ZeroDev Sound 3.0.66 min läsningUppdaterad

ZeroDev Sound kontrollerar varje värde det får och fortsätter fungera när din resurs saknas, är stoppad eller trasig. Tysta timmar, polisens tystande och ägarens volymtak gäller för allt som spelas.

Hitta resursen

Resursen bär manifestmarkeringen audio_extensions 'v1'. Hitta den med den, inte med mappnamnet, eftersom servrar kan döpa om mappen:

Lua
local function soundResource()
    for i = 0, GetNumResources() - 1 do
        local res = GetResourceByFindIndex(i)
        if res and GetResourceState(res) == 'started' and GetResourceMetadata(res, 'audio_extensions', 0) == 'v1' then return res end
    end
end

Anropa den med exports[res]:.... Eventnamn börjar med resursnamnet: res .. ':session'.

En session är en låtström: en grupp länkade högtalare i världen (kind = 'speakers') eller en bils stereo (kind = 'car', nyckel car:<plate>). En låt väljs med en referens: library:<n> (en låt i Config.Library), file:<name> (en fil i web/library) eller request:<n> (ett låtönskemål som ägaren har lagt till).

Server-exports

Export Returnerar
GetSessions() varje session på servern
GetSession(key) en session, eller nil
GetCarSession(vehicle) ett fordons session (entity eller skylttext), eller nil
Targets(src) vad den här spelaren får köra just nu: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() true när Sound har laddats
ApiVersion() 2

Control kör en åtgärd med samma regler som Sounds egen fjärrkontroll: vem som helst i bilen styr dess stereo; ett placerat system följer sin ägare och sin grupp- eller publikinställning, och spelaren måste vara inom räckhåll. Skicka src = 0 för att agera med ditt eget scripts auktoritet, efter att ditt script har avgjort vem som får.

Åtgärd Data
play { text = reference } (utan text: återuppta)
queue { text = reference }
resume, pause, next, previous, stop ingen
volume { value = 0.0 - 1.0 }
seek { at = seconds }
mode { value = 'studio' }, eller bass, club, vocal, concert, night, chipeo
eq { low, mid, high } i dB, -12 till 12
repeatMode { value = 'off' }, eller one, all

När ok är false är reason en av no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only eller error.

Exempel: klubbens högtalare spelar husets låt när DJ:n stämplar in.

Lua
RegisterNetEvent('myclub:clockIn', function()
    local src = source
    for _, t in ipairs(exports[res]:Targets(src)) do
        if t.kind == 'speakers' then
            exports[res]:Control(src, t.key, 'play', { text = 'library:3' })
            exports[res]:Control(src, t.key, 'mode', { value = 'club' })
        end
    end
end)

Fasta högtalare och installationshallar

Ett butiks-, klubb- eller garage-script kan sätta upp egna högtalare och en installationshall i sin byggnad. De har ingen ägare och inget item, sparas aldrig och försvinner när din resurs stoppas. Spelare kan inte flytta eller packa ihop dem; polisen kan fortfarande tysta dem.

Lua
local id, key = exports[res]:AddFixedSpeaker({
    id = 'radio_1',              -- yours to name; adding the same id again moves it
    item = 'zds_room_ceiling',   -- any placed Sound speaker item
    coords = vector3(x, y, z), heading = 90.0,
    pitch = -90.0,               -- on a ceiling, grille down; 0 on a floor or wall
    label = 'Store radio',
    group = 'store',             -- same group = one system
})
exports[res]:RemoveFixedSpeaker('radio_1')
exports[res]:GetFixedSpeakers()  -- { { id, speaker, key } } of your resource

exports[res]:AddBay({ id = 'garage', label = 'Garage audio bay', coords = vector3(x, y, z), radius = 6.0, blip = true })
exports[res]:RemoveBay('garage') -- up to 8 bays per resource, radius 3 to 15 m

Lägg till dem när din resurs startar, och igen på <res>:ready, ifall Sound startar efter dig.

Server-events

Lua
AddEventHandler(res .. ':session', function(key, session) end)   -- any change: song, pause, volume, mode, queue
AddEventHandler(res .. ':songStarted', function(session) end)    -- a different song started
AddEventHandler(res .. ':sessionRemoved', function(key) end)     -- speakers packed up, a car session ended
AddEventHandler(res .. ':ready', function() end)                 -- Sound started and loaded

Det här är server-lokala events som aldrig skickas från en klient, så en klient kan inte förfalska dem.

Klient-exports (skrivskyddade)

Export Returnerar
GetSessions() sessionerna den här klienten känner till: i närheten och sin egen
GetCarSession(vehicle) bilens session, eller nil
GetBass(key) 0.0 till 1.0: basen i den riktiga låten i den här framen, 0 vid tystnad
CarAudioState(vehicle) bilstereons tillstånd, för bilskärmar

Exempel: underglow som pulserar med bilens subs.

Lua
CreateThread(function()
    while true do
        local veh = GetVehiclePedIsIn(PlayerPedId(), false)
        local s = veh ~= 0 and exports[res]:GetCarSession(veh)
        if s and s.title and not s.paused then
            SetVehicleNeonLightsColour(veh, 255, math.floor(40 + 200 * exports[res]:GetBass(s.key)), 255)
            Wait(0)
        else
            Wait(500)
        end
    end
end)

Config-exempel

Inställningarna finns i zerodev-sound/config/config.lua, och varje inställning kan ändras i spelet i /soundadmin.

Lua
Config.Framework = 'auto'        -- or 'esx', 'qb', 'qbox', 'standalone'
Config.Inventory = 'auto'        -- or 'ox', 'qb', 'qs', 'codem', 'core', 'origen', 'tgiann', 'esx', 'none'
Config.MaxPlacedPerPlayer = 8
Config.QuietHours = { enabled = true, from = 23, to = 7, maxVolume = 0.35 }

Regler för integrationer

  • Ändra inte ZeroDev Sounds filer; använd API:et. En ändrad escrow-skyddad fil gör att resursen inte laddas.
  • Skicka den riktiga source till Control, eller kontrollera behörigheten själv innan du använder src = 0.
  • Läs GetBass högst en gång per frame, och sov när inget spelas.
  • API:et är versionshanterat (audio_extensions 'v1', ApiVersion() 2). En brytande ändring får en ny version och en rad i ändringsloggen.

Vanliga frågor

Hur hittar jag ZeroDev Sound från mitt script?

Leta efter resursen vars manifest har audio_extensions 'v1', som i det första exemplet. Mappen kan ha ett annat namn på vissa servrar.

Kan mitt script spela musik på en spelares högtalare?

Ja, med Control(src, key, 'play', { text = 'library:1' }). Samma regler som Sounds egen fjärrkontroll gäller: spelaren måste få köra det systemet och vara inom räckhåll.

Kan ljus eller props följa musiken?

Ja. Klient-exporten GetBass(key) ger basen i låten som spelas, varje frame, från 0 till 1.

Översatt från engelska. Om något här skiljer sig från den engelska sidan är det den engelska sidan som gäller. English