Lua API catalogs: Difference between revisions
Document upcoming 0.1.7 game audio: 11 client APIs, result event, limits and complete dialogue catalog; not a release |
Release 0.1.7 / BUILD199 / Protocol 39: current API availability, setup and improvements |
||
| Line 89: | Line 89: | ||
<!-- game-audio017:start --> | <!-- game-audio017:start --> | ||
== Client game-audio catalog ( | == Client game-audio catalog (since 0.1.7) == | ||
[[Game dialogue catalog]] lists all 34,795 dialogue identifiers. Unlike the server-side catalogs above, [[getGameSoundCatalog]] is a client function; it searches SFX, music and dialogue metadata and supports pagination. Use [[getGameSoundInfo]] for entry metadata and [[Game audio]] for playback. | [[Game dialogue catalog]] lists all 34,795 dialogue identifiers. Unlike the server-side catalogs above, [[getGameSoundCatalog]] is a client function; it searches SFX, music and dialogue metadata and supports pagination. Use [[getGameSoundInfo]] for entry metadata and [[Game audio]] for playback. Available since update 0.1.7. Catalog membership does not guarantee recording availability in every installed language or game version. | ||
<!-- game-audio017:end --> | <!-- game-audio017:end --> | ||
Revision as of 23:49, 10 October 2026
See current Lua, resource and API limits for 0.1.3 BUILD81, all numeric server configuration bounds and all 59 statistic ranges.
Lua API catalogs collect stable, server-validated keys used by G1R:MP resources. Prefer catalog keys and enumeration functions over hard-coded Unreal paths.
Static catalogs
| Catalog | Used by |
|---|---|
| Player skin catalog | setPlayerSkin, setNpcSkin |
| Player body catalog | deprecated compatibility reference for setPlayerBody |
| Player face catalog | deprecated compatibility reference for setPlayerFace |
| Player head catalog | deprecated compatibility reference for setPlayerHead |
| Player identity catalog | supported complete identity setter setPlayerIdentity |
| Player tattoo catalog (available from update 0.1.3) | setPlayerTattoo, getPlayerTattooNames |
| Synchronized spell catalog | basic synchronized spell set for G1R:MP 0.1a |
| Monster type catalog | spawnMonster |
| World item catalog (available from update 0.1.2) | spawnItem and spawnTestItem |
| NPC and monster navigation collision (available from update 0.1.2) | NPC and monster collision-source modes and resource-owned AI navigation blockers |
| Player animation catalog (available from update 0.1.2) | startAnim and stopAnim; expanded to 118 aliases since 0.1.4 BUILD127, with getPlayerAnimationNames and getPlayerAnimationInfo |
Camera scripting
Scripted camera and Camera Functions document camera poses, units, state fields, movement, paths, orbits and client/server ownership. These new functions and their client events are available from update 0.1.3.
Player customization
Player customization documents the seven skin-color and tattoo functions available from update 0.1.3, including RGB ranges, independent resets, tattoo removal and persistence. Existing setPlayerIdentity head/armor handling is improved from update 0.1.3; it is not a newly introduced identity API or a full NPC body replacement.
Observer-specific nameplates
Observer nameplates documents the 12 observer/nameplate-ID functions available from update 0.1.3. Text, whole-label visibility and numeric-ID policy resolve independently for each observer/target pair. The guide covers explicit versus effective getters, exclusive per-field resource ownership, lifecycle, configurable limits, developer-owned acquaintance persistence, and the optional /nametest resource. This is overhead presentation, not network anonymity.
Runtime catalogs
These functions return the authoritative keys supported by the running server build:
| Function | Values |
|---|---|
| getPlayerAnimationNames | Player animation aliases (since 0.1.4); getPlayerAnimationInfo provides mode/timing/group metadata |
| getPlayerArmorNames | Armor keys |
| getPlayerTattooNames | Tattoo preset keys (available from update 0.1.3) |
| getPlayerWeaponNames | Melee weapon keys |
| getPlayerRangedWeaponNames | Bow and crossbow keys |
| getPlayerAmmunitionNames | Ammunition keys |
| getPlayerRuneNames | All rune/spell-item keys; not a synchronization-support list |
| getSpellCatalog | All spell definitions and their implemented status; see Synchronized spell catalog
|
| getPlayerStatNames | Progression statistic keys |
| getPlayerSkillNames | Skill keys |
| getPlayerGuildNames | Guild keys |
Example
local function contains(values, wanted)
for _, value in ipairs(values) do
if value == wanted then
return true
end
end
return false
end
if contains(getPlayerArmorNames(), "none") then
setPlayerArmor(playerId, "none")
end
Client game-audio catalog (since 0.1.7)
Game dialogue catalog lists all 34,795 dialogue identifiers. Unlike the server-side catalogs above, getGameSoundCatalog is a client function; it searches SFX, music and dialogue metadata and supports pagination. Use getGameSoundInfo for entry metadata and Game audio for playback. Available since update 0.1.7. Catalog membership does not guarantee recording availability in every installed language or game version.