ZeroDev Sound dokumentacija
Developer API za ZeroDev Sound
ZeroDev Sound ima otvoren API za druge resurse: čitanje onoga što svira, upravljanje sistemom zvučnika ili auto radiom za igrača iz vlastitog menija, praćenje promjena, postavljanje vlastitih zvučnika i radionica za ugradnju te upravljanje svjetlima prema stvarnom basu. Sve ovdje preuzeto je iz ZeroDev Sound 3.0.5. API fajlovi nisu pod escrowom, pa ugovor možete pročitati sami: server/devapi.lua i client/devapi.lua.
ZeroDev Sound provjerava svaku vrijednost koju dobije i nastavlja raditi kad vaš resurs nedostaje, zaustavljen je ili neispravan. Tihi sati, policijsko utišavanje i ograničenje glasnoće vlasnika važe za sve što svira.
Pronalaženje resursa
Resurs u manifestu ima marker audio_extensions 'v1'. Pronađite ga po njemu, a ne po nazivu foldera, jer serveri mogu preimenovati folder:
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
endPozivajte ga preko exports[res]:.... Nazivi događaja počinju nazivom resursa: res .. ':session'.
Sesija je jedan tok pjesme: grupa povezanih zvučnika u svijetu (kind = 'speakers') ili radio jednog automobila (kind = 'car', ključ car:<plate>). Pjesma se bira po referenci: library:<n> (pjesma u Config.Library), file:<name> (fajl u web/library) ili request:<n> (pjesma koju je vlasnik dodao na zahtjev).
Server exporti
| Export | Vraća |
|---|---|
GetSessions() |
sve sesije na serveru |
GetSession(key) |
jednu sesiju, ili nil |
GetCarSession(vehicle) |
sesiju vozila (entitet ili tekst tablice), ili nil |
Targets(src) |
šta ovaj igrač trenutno smije pokrenuti: { key, kind, label, canPlay, why } |
Control(src, key, action, data) |
ok, reason |
Ready() |
true čim se Sound učita |
ApiVersion() |
2 |
Control izvršava radnju po istim pravilima kao Soundov vlastiti daljinski: svako u automobilu upravlja njegovim radiom; postavljen sistem slijedi svog vlasnika i njegovu postavku za društvo ili javnost, a igrač mora biti na dohvat. Proslijedite src = 0 da djelujete s ovlaštenjem vaše skripte, nakon što je vaša skripta odlučila ko smije.
| Radnja | Podaci |
|---|---|
play |
{ text = reference } (bez text: nastavi) |
queue |
{ text = reference } |
resume, pause, next, previous, stop |
nema |
volume |
{ value = 0.0 - 1.0 } |
seek |
{ at = seconds } |
mode |
{ value = 'studio' }, ili bass, club, vocal, concert, night, chipeo |
eq |
{ low, mid, high } u dB, od -12 do 12 |
repeatMode |
{ value = 'off' }, ili one, all |
Kad je ok false, reason je jedna od vrijednosti no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only ili error.
Primjer: klupski zvučnici puštaju house pjesmu kad se DJ prijavi na smjenu.
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 zvučnici i radionice za ugradnju
Skripta prodavnice, kluba ili garaže može staviti vlastite zvučnike i radionicu za ugradnju u svoju zgradu. Nemaju vlasnika ni predmet, nikad se ne spremaju i nestaju kad se vaš resurs zaustavi. Igrači ih ne mogu pomjerati ni spakovati; policija ih i dalje može utišati.
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 mDodajte ih kad se vaš resurs pokrene, i ponovo na <res>:ready, u slučaju da se Sound pokrene poslije vas.
Server događaji
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 loadedTo su lokalni server događaji koji se nikad ne šalju s klijenta, pa ih klijent ne može lažirati.
Klijentski exporti (samo čitanje)
| Export | Vraća |
|---|---|
GetSessions() |
sesije koje ovaj klijent poznaje: obližnje i vlastita |
GetCarSession(vehicle) |
sesija automobila, ili nil |
GetBass(key) |
od 0.0 do 1.0: bas stvarne pjesme u ovom frameu, 0 kad je tiho |
CarAudioState(vehicle) |
stanje radija, za ekrane automobila |
Primjer: podsvjetlo koje pulsira uz subwoofere automobila.
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)Primjeri konfiguracije
Postavke su u zerodev-sound/config/config.lua, a svaka se može promijeniti u igri u /soundadmin.
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 mijenjajte fajlove ZeroDev Sound; koristite API. Izmijenjen fajl pod escrowom sprečava učitavanje resursa.
- Proslijedite pravi
sourceuControlili sami provjerite dozvolu prije nego što upotrijebitesrc = 0. - Čitajte
GetBassnajviše jednom po frameu i spavajte kad ništa ne svira. - API je verzionisan (
audio_extensions 'v1',ApiVersion()2). Promjena koja lomi kompatibilnost dobija novu verziju i liniju u changelogu.
Česta pitanja
Kako da pronađem ZeroDev Sound iz svoje skripte?
Potražite resurs čiji manifest ima audio_extensions 'v1', kao u prvom primjeru. Folder na nekim serverima može imati drugi naziv.
Može li moja skripta puštati muziku na igračevim zvučnicima?
Da, preko Control(src, key, 'play', { text = 'library:1' }). Važe ista pravila kao za Soundov vlastiti daljinski: igrač mora smjeti pokrenuti taj sistem i biti na dohvat.
Mogu li svjetla ili propovi pratiti muziku?
Da. Klijentski export GetBass(key) daje bas pjesme koja svira, u svakom frameu, od 0 do 1.