Dokumentacija ZeroDev Sound

API za razvijalce ZeroDev Sound

ZeroDev Sound ima odprt API za druge resource: preberite, kaj se predvaja, upravljajte zvočniški sistem ali avtoradio igralca iz svojega menija, spremljajte spremembe, postavite lastne zvočnike in vgradne delavnice ter poganjajte luči iz pravega basa. Vse tukaj je vzeto iz ZeroDev Sound 3.0.5. Datoteke API-ja niso zaščitene z escrow, zato lahko pogodbo preberete sami: server/devapi.lua in client/devapi.lua.

Za ZeroDev Sound 3.0.66 min branjaPosodobljeno

ZeroDev Sound preveri vsako vrednost, ki jo prejme, in deluje naprej, tudi če vaš resource manjka, je ustavljen ali pokvarjen. Tihe ure, utišanje policije in omejitev glasnosti lastnika veljajo za vse, kar se predvaja.

Iskanje resourca

Resource ima manifestno oznako audio_extensions 'v1'. Poiščite ga po njej, ne po imenu mape, ker strežniki mapo lahko preimenujejo:

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

Pokličite ga z exports[res]:.... Imena eventov se začnejo z imenom resourca: res .. ':session'.

seja je en tok pesmi: skupina povezanih zvočnikov v svetu (kind = 'speakers') ali stereo enega avtomobila (kind = 'car', ključ car:<plate>). Pesem izberete z referenco: library:<n> (pesem v Config.Library), file:<name> (datoteka v web/library) ali request:<n> (prošnja za pesem, ki jo je dodal lastnik).

Exporti strežnika

Export Vrne
GetSessions() vse seje na strežniku
GetSession(key) eno sejo ali nil
GetCarSession(vehicle) sejo vozila (entiteta ali besedilo tablice) ali nil
Targets(src) kaj lahko ta igralec zažene zdaj: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() true, ko je Sound naložen
ApiVersion() 2

Control zažene dejanje z enakimi pravili kot Soundov lasten daljinec: vsak v avtomobilu upravlja njegov avtoradio; postavljen sistem sledi lastniku in nastavitvi zabave ali javno, igralec pa mora biti v dosegu. Podajte src = 0, da dejanje izvedete z lastno pooblastitvijo skripta, potem ko je vaš skript odločil, kdo sme.

Dejanje Podatki
play { text = reference } (brez text: nadaljuj)
queue { text = reference }
resume, pause, next, previous, stop brez
volume { value = 0.0 - 1.0 }
seek { at = seconds }
mode { value = 'studio' } ali bass, club, vocal, concert, night, chipeo
eq { low, mid, high } v dB, od -12 do 12
repeatMode { value = 'off' } ali one, all

Ko je ok false, je reason eden od no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only ali error.

Primer: skripti kluba predvajajo hišno pesem, ko DJ začne delo.

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)

Fiksni zvočniki in vgradne delavnice

Skript trgovine, kluba ali garaže lahko v svojo stavbo postavi lastne zvočnike in vgradno delavnico. Nimajo lastnika ali predmeta, se nikoli ne shranijo in izginejo, ko se vaš resource ustavi. Igralci jih ne morejo premikati ali pospraviti; policija jih še vedno lahko utiša.

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

Dodajte jih ob zagonu resourca in znova ob <res>:ready, če se Sound zažene po vas.

Eventi strežnika

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

To so lokalni eventi strežnika, ki se nikoli ne pošljejo iz odjemalca, zato jih odjemalec ne more ponarediti.

Exporti odjemalca (samo za branje)

Export Vrne
GetSessions() seje, ki jih odjemalec pozna: bližnje in njegova lastna
GetCarSession(vehicle) seja avtomobila ali nil
GetBass(key) od 0.0 do 1.0: bas prave pesmi v tej sličici, 0, ko je tiho
CarAudioState(vehicle) stanje avtoradia, za zaslone v avtomobilu

Primer: podsvetlitev, ki utripa z subwooferji avtomobila.

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)

Primeri konfiguracije

Nastavitve so v zerodev-sound/config/config.lua in vsako je mogoče spremeniti v igri v /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 }

Pravila za integracije

  • Ne spreminjajte datotek ZeroDev Sound; uporabite API. Spremenjena datoteka z escrow prepreči nalaganje resourca.
  • Podajte pravi source v Control ali pa sami preverite dovoljenje, preden uporabite src = 0.
  • Berite GetBass največ enkrat na sličico in spite, ko se nič ne predvaja.
  • API ima različice (audio_extensions 'v1', ApiVersion() 2). Prelomna sprememba dobi novo različico in vrstico v dnevniku sprememb.

Pogosta vprašanja

Kako iz svojega skripta najdem ZeroDev Sound?

Poiščite resource, katerega manifest ima audio_extensions 'v1', kot v prvem primeru. Mapa ima lahko na nekaterih strežnikih drugo ime.

Ali lahko moj skript predvaja glasbo na igralčevih zvočnikih?

Da, z Control(src, key, 'play', { text = 'library:1' }). Veljajo ista pravila kot za Soundov lasten daljinec: igralec mora imeti dovoljenje za upravljanje tega sistema in biti v dosegu.

Ali lahko luči ali propi sledijo glasbi?

Da. Export odjemalca GetBass(key) vrača bas pesmi, ki se predvaja, vsako sličico, od 0 do 1.

Prevedeno iz angleščine. Če se kaj na tej strani ne ujema z angleško stranjo, velja angleška stran. English