Skip to content

XsGetUnitAttributeHeld

Read unit attribute held from native game state.

XsGetUnitAttributeHeld(unitId, attributeId)

Inputs: unitId is an integer unit ID; attributeId is an integer attribute ID.

Output: value, available: number when available is true; nil, false when unavailable.

Errors and unavailable states: Wrong numeric argument types raise a Lua argument error. Invalid IDs or an unavailable native query return nil, false; use the availability flag before reading the value.

See Low-level queries for related calls and usage notes.