ZeroDev Sound-dokumentation

ZeroDev Sound udvikler-API

ZeroDev Sound har et åbent API til andre resources: læs, hvad der afspilles, styr et højttalersystem eller en bilstereo for en spiller fra din egen menu, følg ændringer, placér egne højttalere og installationspladser, og styr lys efter den rigtige bas. Alt her er hentet fra ZeroDev Sound 3.0.5. API-filerne er ikke escrowed, så du kan selv læse kontrakten: server/devapi.lua og client/devapi.lua.

Til ZeroDev Sound 3.0.66 min. læsetidOpdateret

ZeroDev Sound kontrollerer hver værdi, det får, og bliver ved med at virke, når din resource mangler, er stoppet eller er i stykker. Stilletimer, politiets tavsgørelse og ejerens lydstyrkegrænse gælder for alt, der afspilles.

Sådan finder du resourcen

Resourcen bærer manifestmarkeringen audio_extensions 'v1'. Find den ud fra den, ikke ud fra mappenavnet, fordi servere kan omdøbe 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

Kald den med exports[res]:.... Eventnavne starter med resourcenavnet: res .. ':session'.

En session er én sangstream: en gruppe forbundne højttalere i verden (kind = 'speakers') eller én bils stereo (kind = 'car', nøgle car:<plate>). En sang vælges med en reference: library:<n> (en sang i Config.Library), file:<name> (en fil i web/library) eller request:<n> (en sangforespørgsel, ejeren har tilføjet).

Server-exports

Export Returnerer
GetSessions() alle sessioner på serveren
GetSession(key) én session, eller nil
GetCarSession(vehicle) et køretøjs session (entity eller nummerpladetekst), eller nil
Targets(src) hvad denne spiller må styre lige nu: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() true, når Sound er indlæst
ApiVersion() 2

Control udfører en handling efter de samme regler som Sounds egen fjernbetjening: alle i bilen styrer dens stereo; et opstillet system følger sin ejer og sin indstilling for gruppe eller offentlig, og spilleren skal være inden for rækkevidde. Giv src = 0 med for at handle med dit eget scripts myndighed, når dit script har afgjort, hvem der må.

Handling Data
play { text = reference } (uden text: genoptag)
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 til 12
repeatMode { value = 'off' } eller one, all

Når ok er false, er reason en af no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only eller error.

Eksempel: klubbens højttalere spiller husesangen, når dj'en stempler ind.

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)

Faste højttalere og installationspladser

Et butiks-, klub- eller garagescript kan sætte sine egne højttalere og en installationsplads op i sin bygning. De har ingen ejer og intet item, gemmes aldrig og forsvinder, når din resource stopper. Spillerne kan ikke flytte eller pakke dem sammen; politiet kan stadig tavse 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

Tilføj dem, når din resource starter, og igen ved <res>:ready, hvis Sound skulle starte 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 er server-lokale events, der aldrig sendes fra en client, så en client kan ikke forfalske dem.

Client-exports (skrivebeskyttede)

Export Returnerer
GetSessions() de sessioner, denne client kender: i nærheden og sin egen
GetCarSession(vehicle) bilens session, eller nil
GetBass(key) 0.0 til 1.0: bassen i den rigtige sang i dette frame, 0 ved stilhed
CarAudioState(vehicle) head unit'ens tilstand, til bilskærme

Eksempel: underglow, der pulserer 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)

Konfigurationseksempler

Indstillingerne står i zerodev-sound/config/config.lua, og hver enkelt kan ændres i spillet 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 for integrationer

  • Ret ikke i ZeroDev Sounds filer; brug API'et. En ændret escrowed fil forhindrer resourcen i at indlæses.
  • Giv den rigtige source videre til Control, eller tjek selv tilladelsen, før du bruger src = 0.
  • Læs GetBass højst én gang pr. frame, og sov, når intet afspilles.
  • API'et er versioneret (audio_extensions 'v1', ApiVersion() 2). En ændring, der bryder noget, får en ny version og en linje i changeloggen.

Ofte stillede spørgsmål

Hvordan finder jeg ZeroDev Sound fra mit script?

Led efter den resource, hvis manifest har audio_extensions 'v1', som i det første eksempel. Mappen kan have et andet navn på nogle servere.

Kan mit script afspille musik på en spillers højttalere?

Ja, med Control(src, key, 'play', { text = 'library:1' }). De samme regler som Sounds egen fjernbetjening gælder: spilleren skal have lov til at styre det system og være inden for rækkevidde.

Kan lys eller props følge musikken?

Ja. Client-exporten GetBass(key) giver bassen i den sang, der spiller, hvert frame, fra 0 til 1.

Oversat fra engelsk. Hvis noget her ikke stemmer overens med den engelske side, er det den engelske side, der gælder. English