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

Documentation error #34

Open SauceChord opened 1 year ago

SauceChord commented 1 year ago

https://github.com/dual-universe/lua-examples/blob/2d20d5089b2f66248ef447616b3cc94835e2a7a5/api-mockup/coreunit.lua#L202

This snippet of code.

    --- Returns the mass of the Element, identified by its local ID
    ---@param localId integer The local ID of the Element
    ---@return number value The maximum hitpoints of the Element
    function self.getElementMassById(localId) end

The ---@return number value The maximum hitpoints of the Element should not be about maximum hitpoints but the mass of the element.