New Documentation of UISpriteElement.floating (and likely other inherited properties) incorrect
Describe the bug
The new documentation says UISpriteElement.floating is default false, as inherited from Sprite.floating -> Renderable.floating: https://melonjs.github.io/melonJS/classes/UISpriteElement.html#floating .
Even though the UISpriteElement and other inherited classes change the floating property to default true and are correctly documented in jsdoc, e.g. https://github.com/melonjs/melonJS/blob/a7ee9e075cb18258d929a4b464abd36a88dcfb7d/src/renderable/ui/uispriteelement.js#L77-L83 the generated webdoc still says they are false by default. This caused me to pull out my hair for a few hours until I just looked it up in the source...
To Reproduce
- Implement a UISpriteElement
- Instantiate it and place it in a container (world or whichever you like that is movable)
- move that container (.translate(), .centerOn(), etc.)
- UISpriteElement stays at its instantiated screen coordinates instead of moving with the container coordinates.
Expected behavior
UISpriteElement should move with the container if, as the documentation says, floating=false.
Device (please complete the following information):
- Device: Desktop PC
- OS: Arch Linux (up to date 20240702)
- Browser: all tested (Chromium, Firefox, Vanadium on Android)
- melonJS Version: 17.3.0
damn indeed ! So sorry for the lost hairs, and thanks for reporting it. We still have a few tweaks or this kind of unwanted behaviour from typedoc to fix since we moved away from webdoc.