GetNpcIdentity

From Wiki G1R-MP G1 Remake Multiplayer
Jump to navigation Jump to search

getNpcIdentity

AVAILABLE FROM UPDATE 0.1.5
This function is available in G1R:MP 0.1.5 and later. The contract below includes the compatibility guarantees introduced in that update.

Reads the authoritative NPC identity selection.

Syntax

getNpcIdentity(npcId)

Parameters

Name Type Required Description
npcId int yes NPC ID returned by spawnNpc; not a player ID.

Returns

Identity key string, or false for an unavailable NPC.

Examples

local identity = getNpcIdentity(npcId)

Notes

  • Server-side only. Mutations require the resource that owns this NPC; getters do not grant control.
  • Available from update 0.1.5. See NPC scripting#NPC appearance since 0.1.5.
  • The authoritative state is replayed for relevance entry/late join. Rendering is asynchronous; acceptance does not mean the mesh has finished rebuilding.
  • Does not change authoritative HP, weapons, armor, routes or combat configuration. No automatic persistent database storage.
  • Upper-initial alias GetNpcIdentity is also supported.
  • Returns default before any explicit selection. getNpcData(npcId).identityExplicit distinguishes this from an explicit default reset. Legacy skin fallback is not an explicit identity selection.