Skip to content

New Documentation of UISpriteElement.floating (and likely other inherited properties) incorrect #1237

@Waltibaba

Description

@Waltibaba

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.

* if this UISpriteElement should use screen coordinates or local coordinates
* (Note: any UISpriteElement elements added to a floating parent container should have their floating property to false)
* @see Renderable.floating
* @type {boolean}
* @default true
*/
this.floating = true;
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

  1. Implement a UISpriteElement
  2. Instantiate it and place it in a container (world or whichever you like that is movable)
  3. move that container (.translate(), .centerOn(), etc.)
  4. 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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions