GetNpcCombatState

From Wiki G1R-MP G1 Remake Multiplayer
Revision as of 17:14, 25 September 2026 by QCherry (talk | contribs) (Document new NPC/player-mode API and events available from 0.1.5)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

getNpcCombatState

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 NPC projectile-controller status and resources.

Syntax

getNpcCombatState(npcId)

Parameters

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

Returns

Returns table {phase, rejectReason, target, mode, mana, maxMana, arrows, bolts}, or false.

Examples

local state = getNpcCombatState(npcId)
if state then outputDebugString(state.phase) end

Notes

  • Server-side only. Mutations require the NPC to belong to the calling resource; getters do not grant control.
  • Since 0.1.5. This documents the next release; public 0.1.4 does not include these additions.
  • Use matching updated client and server. See NPC scripting for lifecycle, defaults, combat examples and collision limitations.
  • phase is a string, rejectReason a numeric subsystem code, target is a player ID or 0. This is not a visual-animation confirmation or complete melee FSM. See NPC scripting#Combat status.