https://g1r-mp.com/wiki/index.php?action=history&feed=atom&title=GetGameSoundInfoGetGameSoundInfo - Revision history2026-10-01T16:25:41ZRevision history for this page on the wikiMediaWiki 1.46.0https://g1r-mp.com/wiki/index.php?title=GetGameSoundInfo&diff=1179&oldid=prevQCherry: Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release2026-10-01T10:20:29Z<p>Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release</p>
<p><b>New page</b></p><div>= getGameSoundInfo =<br />
<div style="background:#fff5f5; border:1px solid #d13b3b; border-left:5px solid #d13b3b; color:#111111; padding:0.85rem 1rem; margin:0.75rem 0 1rem;"><br />
<div style="color:#111111; font-weight:bold; letter-spacing:0.04em;">PLANNED FOR UPDATE 0.1.7</div><br />
<div style="color:#111111; margin-top:0.25rem;">This function is planned for G1R:MP 0.1.7. It is not included in the public 0.1.6 release.</div><br />
</div><br />
<br />
Returns compiled catalog metadata and, when available, the last successful preload metadata for the current client resource.<br />
<br />
== Syntax ==<br />
<syntaxhighlight lang="lua"><br />
table|false getGameSoundInfo(string key)<br />
</syntaxhighlight><br />
<br />
== Parameters ==<br />
{| class="wikitable"<br />
! Name !! Type !! Required !! Description<br />
|-<br />
| <code>key</code> || <code>string</code> || yes || Exact, case-sensitive key from [[getGameSoundCatalog]]. Accepts catalog entries only; no filename, URL or arbitrary event name.<br />
|}<br />
<br />
== Returns ==<br />
Returns <code>false</code> for an unknown key. Otherwise returns a Lua table with <code>key</code> (string), <code>category</code> (string: <code>sfx</code>, <code>music</code> or <code>dialogue</code>), <code>speaker</code> (string, empty when unspecified), <code>verifiedInGame = false</code> and <code>capabilitiesKnown = false</code> before a successful preload.<br />
<br />
After a successful [[preloadGameSound]] in the same resource, the table can also contain:<br />
<br />
{| class="wikitable"<br />
! Field !! Type !! Meaning<br />
|-<br />
| <code>capabilitiesKnown</code> || bool || True once native event capabilities have been queried successfully.<br />
|-<br />
| <code>studioEvent</code> || string || Actual resolved game event, including any dialogue template fallback.<br />
|-<br />
| <code>lookup</code> || string || Diagnostic lookup method, currently <code>FMOD.FindEventByName</code>.<br />
|-<br />
| <code>authoredSpatial</code>, <code>oneShot</code> || bool || Event capabilities reported by FMOD. <code>oneShot = false</code> is not a guarantee of a simple loop.<br />
|-<br />
| <code>loopMode</code> || string || Currently <code>authored</code>; looping follows the event's design.<br />
|-<br />
| <code>eventSamplesPreloaded</code> || bool || True in a successful preload result.<br />
|-<br />
| <code>voicePreloadRequested</code>, <code>voicePreloadConfirmed</code> || bool || Whether dialogue preload was requested and independently confirmed. The current implementation always reports <code>voicePreloadConfirmed = false</code>.<br />
|-<br />
| <code>nativeMs</code> || number || Native processing time in milliseconds for the completed preload attempt; excludes earlier retries and is not total load latency.<br />
|}<br />
<br />
Dialogue replies may additionally contain <code>recordingResolved</code>, <code>controllerPresent</code>, <code>controllerRootPresent</code>, <code>pawnRootPresent</code>, <code>viewTargetQuerySucceeded</code>, <code>viewTargetPresent</code>, <code>viewTargetIsLocalPawn</code> and <code>viewTargetRootPresent</code> (booleans), plus <code>voiceLanguageSet</code> (string, when available).<br />
<br />
Dialogue playback results and [[getGameSoundState]] can also expose <code>localizedTextPathPresent</code>, <code>localizedTextPathMatchesId</code>, <code>identityPathVerified</code> and <code>recordingPrepared</code> (booleans), <code>resolution</code> (string: <code>localized-text-record</code> or <code>verified-catalog-identity</code>), and <code>recordingDurationSeconds</code> (positive number). These playback-only fields are not populated by this function's preload cache.<br />
<br />
== Examples ==<br />
Read catalog metadata without starting playback:<br />
<syntaxhighlight lang="lua" line><br />
local info = getGameSoundInfo("voice/INFO_DIEGO_BARRIERE_11_01")<br />
if info then<br />
outputDebugString(info.category .. ": " .. info.speaker)<br />
outputDebugString("Native capabilities known: " .. tostring(info.capabilitiesKnown))<br />
end<br />
</syntaxhighlight><br />
<br />
== Notes ==<br />
* Planned for update 0.1.7; not included in public 0.1.6.<br />
* Available only in client-side resource scripts. See [[Game audio]] for ownership, lifecycle, limits and server-triggered playback.<br />
* This function submits no native request. Catalog metadata is available before the game is ready.<br />
* Only a successful preload updates the per-resource information cache. Playing a sound alone does not set this function's <code>capabilitiesKnown</code> to true; inspect that sound's state for playback metadata.<br />
* <code>verifiedInGame</code> remains false. Capability flags, prepared recording duration and observed playback state do not prove that audio was audible.<br />
* Optional diagnostic fields can be absent, particularly on an early failure. They describe the game state at the time of that result and do not expose native paths or pointers.<br />
* Resource/session cleanup clears cached preload metadata. The catalog entry itself remains available.<br />
<br />
[[Category:Lua Functions]]<br />
[[Category:Client Functions]]<br />
[[Category:Audio Functions]]</div>QCherry