unit:speed¶
Read available velocity magnitude, or nil.
Signature¶
Contract and usage¶
unit:speed()¶
Returns the magnitude of the prepared velocity, or nil when unavailable.
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.
World-space units¶
Distance, position and velocity use the same game-world coordinate scale. One world unit is ten metres. Convert range thresholds exactly once; a 30-metre threshold is 3 world units. World-space circle radii use this scale too.