dual-universe / lua-examples

This repository has been created to serve as a sharing and learning platform for the Dual Universe community and the development of simple and complex Lua applications. You will find on this repo the examples released by Novaquark during the devblog and thread.
https://www.dualuniverse.game
GNU General Public License v3.0
59 stars 19 forks source link

core.getWorldVertical misleading #17

Closed seennotheard closed 1 year ago

seennotheard commented 1 year ago

core.getWorldVertical actually points downwards, ie same direction as gravity. There should be documentation specifying the direction.

NQ-Ligo commented 1 year ago
    --- Returns the vertical unit vector along gravity, in world coordinates (0 in space)
    ---@return table value The local vertical vector in world coordinates in meters
    function self.getWorldVertical() end

The documentation says it's along the gravity. Is that not clear?

seennotheard commented 1 year ago

In the documentation, "along gravity" can generally be perceived to mean that it is colinear with the gravity vector, but it does not really specify a direction. Perhaps a better description would be "Returns the gravity unit vector, in world coordinates (0 in space)"

NQ-Ligo commented 1 year ago

Can be better indeed, I will replace it here and in game later.