Skip to content

XsGetWorldPlayerId

Read world player id from native game state.

XsGetWorldPlayerId(scenarioPlayerId)

Inputs: scenarioPlayerId is an integer scenario player ID.

Output: value, available: integer 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.