Skip to content

GetPlayerDistance

Read player distance from current game state.

GetPlayerDistance(playerId)

Inputs: playerId is an integer game player ID.

Output: Numeric fact value, or nil when unavailable.

Errors and unavailable states: Wrong numeric argument types raise a Lua argument error. An unavailable fact read returns nil; there is no separate error string.

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