Skip to content

unit:is_local_player

Test whether this current unit is the local player.

Signature

unit:is_local_player()

Contract and usage

unit:is_local_player()

Returns whether this current unit is the local player.

Unit Identity And Lifetime

Every GosUnit state-reading method raises stale_unit after its world generation expires. unit:handle() is the exception and remains available so the unit can be reacquired with a fresh world:resolve(handle).

Within one world, repeated lookups of the same unit compare equal with ==. Values from different generations compare unequal even when their handles match.

Full world and units contract