ZeroDev Sound dokümantasyonu

ZeroDev Sound geliştirici API'si

ZeroDev Sound, diğer resource'lar için açık bir API sunar: çalanı okuyun, kendi menünüzden bir oyuncu için hoparlör sistemi veya araç teybi çalıştırın, değişiklikleri izleyin, kendi hoparlörlerinizi ve kurulum bölmelerinizi yerleştirin ve ışıkları gerçek basla sürün. Buradaki her şey ZeroDev Sound 3.0.5'ten alınmıştır. API dosyaları escrow'lu değildir, sözleşmeyi kendiniz okuyabilirsiniz: server/devapi.lua ve client/devapi.lua.

ZeroDev Sound 3.0.6 için6 dk okumaGüncelleme:

ZeroDev Sound kendisine verilen her değeri denetler ve resource'unuz eksik, durmuş veya bozuk olsa da çalışmaya devam eder. Sessiz saatler, polis susturması ve sahibin ses sınırı çalan her şeye uygulanır.

Resource'u bulma

Resource, manifest işareti audio_extensions 'v1' taşır. Sunucular klasörü yeniden adlandırabileceği için onu klasör adıyla değil bu işaretle bulun:

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

exports[res]:... ile çağırın. Olay adları resource adıyla başlar: res .. ':session'.

Oturum tek bir şarkı akışıdır: dünyada bağlı bir hoparlör grubu (kind = 'speakers') veya bir aracın teybi (kind = 'car', anahtar car:<plate>). Şarkı bir referansla seçilir: library:<n> (Config.Library içindeki bir şarkı), file:<name> (web/library içindeki bir dosya) veya request:<n> (sahibin eklediği bir şarkı isteği).

Sunucu export'ları

Export Döndürür
GetSessions() sunucudaki her oturum
GetSession(key) tek bir oturum veya nil
GetCarSession(vehicle) bir aracın oturumu (entity veya plaka metni) veya nil
Targets(src) bu oyuncunun şu anda çalıştırabildikleri: { key, kind, label, canPlay, why }
Control(src, key, action, data) ok, reason
Ready() Sound yüklendikten sonra true
ApiVersion() 2

Control, Sound'un kendi kumandasıyla aynı kurallarla bir eylem çalıştırır: araçtaki herkes teybi kullanır; yerleştirilmiş bir sistem sahibini ve parti ya da herkese açık ayarını izler ve oyuncunun erişim mesafesinde olması gerekir. Scriptiniz kimin yetkili olduğuna karar verdikten sonra, kendi yetkinizle işlem yapmak için src = 0 verin.

Eylem Veri
play { text = reference } (text olmadan: devam ettir)
queue { text = reference }
resume, pause, next, previous, stop yok
volume { value = 0.0 - 1.0 }
seek { at = seconds }
mode { value = 'studio' } veya bass, club, vocal, concert, night, chipeo
eq dB cinsinden { low, mid, high }, -12 ile 12 arası
repeatMode { value = 'off' } veya one, all

ok false olduğunda reason şunlardan biridir: no_session, bad_action, no_player, not_inside, out_of_range, not_allowed, mixer_alone, no_text, catalogue_only veya error.

Örnek: DJ mesaiye girince kulüp hoparlörleri house şarkısını çalar.

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)

Sabit hoparlörler ve kurulum bölmeleri

Bir mağaza, kulüp veya garaj scripti binasına kendi hoparlörlerini ve bir kurulum bölmesi koyabilir. Bunların sahibi ve eşyası yoktur, hiçbir zaman kaydedilmez ve resource'unuz durduğunda kalkar. Oyuncular bunları taşıyamaz veya toplayamaz; polis yine de susturabilir.

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

Bunları resource'unuz başlarken ve Sound sizden sonra başlarsa diye <res>:ready olayında tekrar ekleyin.

Sunucu olayları

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

Bunlar sunucuya yerel olaylardır, istemciden asla gönderilmez; dolayısıyla bir istemci bunları taklit edemez.

İstemci export'ları (salt okunur)

Export Döndürür
GetSessions() bu istemcinin bildiği oturumlar: yakındakiler ve kendisininki
GetCarSession(vehicle) aracın oturumu veya nil
GetBass(key) 0.0 ile 1.0 arası: bu karedeki gerçek şarkının sesi, sessizken 0
CarAudioState(vehicle) teybin durumu, araç ekranları için

Örnek: aracın subwoofer'larıyla birlikte nabız gibi atan neon.

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)

Yapılandırma örnekleri

Ayarlar zerodev-sound/config/config.lua içindedir ve hepsi oyunda /soundadmin ile değiştirilebilir.

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 }

Entegrasyon kuralları

  • ZeroDev Sound'un dosyalarını değiştirmeyin; API'yi kullanın. Escrow'lu bir dosyanın değiştirilmesi resource'un yüklenmesini durdurur.
  • Gerçek source değerini Control'e verin veya src = 0 kullanmadan önce yetkiyi kendiniz kontrol edin.
  • GetBass'ı kare başına en fazla bir kez okuyun ve hiçbir şey çalmıyorsa bekleyin.
  • API sürümlüdür (audio_extensions 'v1', ApiVersion() 2). Uyumsuz bir değişiklik yeni sürüm alır ve değişiklik günlüğüne bir satır eklenir.

Sık sorulan sorular

ZeroDev Sound'u scriptimden nasıl bulurum?

İlk örnekteki gibi manifest'inde audio_extensions 'v1' bulunan resource'u arayın. Bazı sunucularda klasörün adı farklı olabilir.

Scriptim bir oyuncunun hoparlörlerinde müzik çalabilir mi?

Evet, Control(src, key, 'play', { text = 'library:1' }) ile. Sound'un kendi kumandasıyla aynı kurallar geçerlidir: oyuncunun o sistemi çalıştırma yetkisi olmalı ve erişim mesafesinde bulunmalıdır.

Işıklar veya proplar müziği takip edebilir mi?

Evet. GetBass(key) istemci export'u, çalan şarkının basını her karede 0 ile 1 arasında verir.

İngilizceden çevrilmiştir. Buradaki herhangi bir bilgi İngilizce sayfayla çelişirse İngilizce sayfa geçerlidir. English