Skip to content

MeshPickingPlugin is not mentioned in the module doc #19458

Open
@djeedai

Description

@djeedai

How can Bevy's documentation be improved?

The bevy_picking module doc doesn't mention anywhere the MeshPickingPlugin, which is critical not only for 3D meshes but also for 2D ones, because:

  • that plugin is not added by default
  • 2D meshes are different from sprites, so require the MeshPickingPlugin

The result is that spawning a Mesh2d + PickingInteraction does nothing, and the user can't understand why from docs.

In fact, even for 3D meshes, that top-level module documentation never mentions this plugin, despite the fact the doc does refer to mesh picking.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-PickingPointing at and selecting objects of all sortsC-DocsAn addition or correction to our documentationD-StraightforwardSimple bug fixes and API improvements, docs, test and examplesS-Ready-For-ImplementationThis issue is ready for an implementation PR. Go for it!

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions