ZeroDev Sound dokumentáció

ZeroDev Sound fejlesztői API

A ZeroDev Sound nyílt API-t kínál más resource-oknak: kiolvashatod, mi szól, működtethetsz egy hangszórórendszert vagy autórádiót egy játékosnak a saját menüdből, követheted a változásokat, elhelyezhetsz saját hangszórókat és szerelőműhelyeket, és a valódi basszusról vezérelhetsz fényeket. Minden itt a ZeroDev Sound 3.0.5-ből származik. Az API fájlokat nem védi escrow, így magad is elolvashatod a szerződést: server/devapi.lua és client/devapi.lua.

ZeroDev Sound 3.0.6-höz6 perc olvasásFrissítve:

A ZeroDev Sound minden kapott értéket ellenőriz, és akkor is működik tovább, ha a resource-od hiányzik, le van állítva vagy hibás. A csendes órák, a rendőrségi elhallgattatás és a tulajdonos hangerőkorlátja mindenre vonatkozik, ami szól.

A resource megtalálása

A resource a következő manifest jelölést hordozza: audio_extensions 'v1'. Ezt keresd, ne a mappa nevét, mert a szerverek átnevezhetik a mappát:

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

Hívd így: exports[res]:.... Az eventek nevei a resource nevével kezdődnek: res .. ':session'.

session egy dalfolyam: a világban összekapcsolt hangszórók csoportja (kind = 'speakers') vagy egy autó rádiója (kind = 'car', kulcs: car:<plate>). A dalt egy hivatkozás: library:<n> jelöli ki (egy dal itt: Config.Library), file:<name> (egy fájl itt: web/library) vagy request:<n> (a tulajdonos által hozzáadott dalkérés).

Szerver exportok

Export Visszaad
GetSessions() minden session a szerveren
GetSession(key) egy session, vagy nil
GetCarSession(vehicle) egy jármű sessionje (entitás vagy rendszám szöveg), vagy nil
Targets(src) mit futtathat ez a játékos éppen most: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() true, amint a Sound betöltődött
ApiVersion() 2

Control végrehajt egy műveletet ugyanazokkal a szabályokkal, mint a Sound saját távirányítója: az autóban bárki vezérli annak rádióját; egy lerakott rendszer a tulajdonosát és a party vagy nyilvános beállítását követi, és a játékosnak elérhető távolságban kell lennie. Add át: src = 0 hogy a script saját jogosultságával hajtsd végre, miután a script eldöntötte, kinek szabad.

Művelet Adat
play { text = reference } (nélküle text: folytatás)
queue { text = reference }
resume, pause, next, previous, stop nincs
volume { value = 0.0 - 1.0 }
seek { at = seconds }
mode { value = 'studio' } vagy bass, club, vocal, concert, night, chipeo
eq { low, mid, high } dB-ben, -12 és 12 között
repeatMode { value = 'off' } vagy one, all

Ha ok false, a reason ezek egyike: no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only vagy error.

Példa: a klub hangszórói a house dalt játsszák, amikor a DJ szolgálatba lép.

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)

Fix hangszórók és szerelőműhelyek

Egy bolt, klub vagy garázs script elhelyezhet saját hangszórókat és egy szerelőműhelyt az épületében. Nincs tulajdonosuk vagy tárgyuk, soha nem mentődnek, és eltűnnek, amikor a resource-od leáll. A játékosok nem mozgathatják vagy csomagolhatják el őket; a rendőrség még elhallgattathatja őket.

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

Add hozzá őket a resource indulásakor, és újra ennél: <res>:ready, arra az esetre, ha a Sound utánad indul.

Szerver eventek

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

Ezek szerver-helyi eventek, soha nem kliensből küldöttek, ezért egy kliens nem tudja meghamisítani őket.

Kliens exportok (csak olvasható)

Export Visszaad
GetSessions() a kliens által ismert sessionök: a közeliek és a sajátja
GetCarSession(vehicle) az autó sessionje, vagy nil
GetBass(key) 0.0-tól 1.0-ig: a valódi dal basszusa ebben a képkockában, 0 csend esetén
CarAudioState(vehicle) a fejegység állapota, autós képernyőkhöz

Példa: az autó mélyládáival pulzáló alvilágítás.

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)

Konfigurációs példák

A beállítások itt vannak: zerodev-sound/config/config.lua, és mindegyik megváltoztatható játékban itt: /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 }

Szabályok integrációkhoz

  • Ne módosítsd a ZeroDev Sound fájljait; használd az API-t. Egy módosított escrow fájl megakadályozza a resource betöltését.
  • Add át a valódi source ide: Control, vagy ellenőrizd te magad az engedélyt, mielőtt ezt használod: src = 0.
  • Olvasd ezt: GetBass legfeljebb képkockánként egyszer, és aludj, amikor semmi nem szól.
  • Az API verziózott (audio_extensions 'v1', ApiVersion() 2). Egy törő változás új verziót kap, és egy sort a változásnaplóban.

Gyakran ismételt kérdések

Hogyan találom meg a ZeroDev Soundot a scriptemből?

Keresd azt a resource-ot, amelynek a manifestjében ez szerepel: audio_extensions 'v1', mint az első példában. A mappának más neve lehet néhány szerveren.

Lejátszhat a scriptem zenét egy játékos hangszóróin?

Igen, ezzel: Control(src, key, 'play', { text = 'library:1' }). Ugyanazok a szabályok érvényesek, mint a Sound saját távirányítójára: a játékosnak futtathatnia kell az adott rendszert, és elérhető távolságban kell lennie.

Követhetik a fények vagy propok a zenét?

Igen. A kliens export GetBass(key) képkockánként 0-tól 1-ig adja a szóló dal basszusát.

Angolból fordítva. Ha bármi itt eltér az angol oldaltól, az angol oldal a mérvadó. English