ZeroDev Sound-dokumentasjon

ZeroDev Sound utvikler-API

ZeroDev Sound har et åpent API for andre resources: les hva som spilles, styr et høyttalersystem eller en bilstereo for en spiller fra din egen meny, følg endringer, plasser egne høyttalere og installasjonsplasser, og styr lys etter den ekte bassen. Alt her er hentet fra ZeroDev Sound 3.0.5. API-filene er ikke escrowed, så du kan lese kontrakten selv: server/devapi.lua og client/devapi.lua.

For ZeroDev Sound 3.0.66 min lesetidOppdatert

ZeroDev Sound kontrollerer hver verdi det får og fortsetter å fungere når resourcen din mangler, er stoppet eller er ødelagt. Stille timer, politiets dempning og eierens volumgrense gjelder for alt som spilles.

Slik finner du resourcen

Resourcen har manifestmarkøren audio_extensions 'v1'. Finn den på den, ikke på mappenavnet, fordi servere kan gi mappen nytt navn:

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

Kall den med exports[res]:.... Eventnavn begynner med resourcenavnet: res .. ':session'.

En sesjon er én sangstrøm: en gruppe koblede høyttalere i verden (kind = 'speakers') eller én bils stereo (kind = 'car', nøkkel car:<plate>). En sang velges med en referanse: library:<n> (en sang i Config.Library), file:<name> (en fil i web/library) eller request:<n> (en sangforespørsel eieren har lagt til).

Server-exports

Export Returnerer
GetSessions() alle sesjoner på serveren
GetSession(key) én sesjon, eller nil
GetCarSession(vehicle) sesjonen til et kjøretøy (entity eller skilttekst), eller nil
Targets(src) hva denne spilleren kan styre akkurat nå: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() true når Sound er lastet
ApiVersion() 2

Control utfører en handling etter de samme reglene som Sounds egen fjernkontroll: alle i bilen styrer stereoen; et plassert system følger eieren og innstillingen for gruppe eller offentlig, og spilleren må være innen rekkevidde. Send src = 0 for å handle med ditt eget scripts myndighet, etter at scriptet ditt har avgjort hvem som får lov.

Handling Data
play { text = reference } (uten text: gjenoppta)
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 av no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only eller error.

Eksempel: klubbhøyttalerne spiller husesangen når DJ-en stempler inn.

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øyttalere og installasjonsplasser

Et butikk-, klubb- eller garasjescript kan sette opp egne høyttalere og en installasjonsplass i bygningen sin. De har ingen eier og ingen item, lagres aldri og forsvinner når resourcen din stopper. Spillerne kan ikke flytte eller pakke dem sammen; politiet kan fortsatt dempe 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

Legg dem til når resourcen din starter, og igjen ved <res>:ready, i tilfelle Sound starter etter deg.

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

Dette er server-lokale events som aldri sendes fra en client, så en client kan ikke forfalske dem.

Client-exports (skrivebeskyttet)

Export Returnerer
GetSessions() sesjonene denne clienten kjenner: i nærheten og sin egen
GetCarSession(vehicle) bilens sesjon, eller nil
GetBass(key) 0.0 til 1.0: bassen i den ekte sangen i dette framet, 0 ved stillhet
CarAudioState(vehicle) head unit-ens tilstand, for bilskjermer

Eksempel: underglow som pulserer med bilens subber.

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)

Konfigurasjonseksempler

Innstillingene ligger i zerodev-sound/config/config.lua, og hver enkelt kan endres 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 integrasjoner

  • Ikke endre filene til ZeroDev Sound; bruk API-et. En endret escrowed fil hindrer resourcen i å laste.
  • Send den ekte source til Control, eller sjekk tillatelsen selv før du bruker src = 0.
  • Les GetBass høyst én gang per frame, og sov når ingenting spilles.
  • API-et har versjoner (audio_extensions 'v1', ApiVersion() 2). En endring som bryter noe får en ny versjon og en linje i endringsloggen.

Ofte stilte spørsmål

Hvordan finner jeg ZeroDev Sound fra scriptet mitt?

Se etter resourcen som har audio_extensions 'v1' i manifestet, som i det første eksemplet. Mappen kan ha et annet navn på noen servere.

Kan scriptet mitt spille musikk på en spillers høyttalere?

Ja, med Control(src, key, 'play', { text = 'library:1' }). De samme reglene som Sounds egen fjernkontroll gjelder: spilleren må ha lov til å styre det systemet og være innen rekkevidde.

Kan lys eller props følge musikken?

Ja. Client-exporten GetBass(key) gir bassen i sangen som spilles, hvert frame, fra 0 til 1.

Oversatt fra engelsk. Hvis noe her ikke stemmer med den engelske siden, er det den engelske siden som gjelder. English