Skip to content

MouseEvent and KeyEvent references are missing #631

Open
@KeesR

Description

@KeesR

Select the type of content error.

Other content error (please specify)

Section

Reference

Location of the error

https://processing.org/reference/mouseWheel_.html

Describe the error

There are no reference sections for MouseEvent and KeyEvent.
All mouse*() key*() methods accept such an object, but most reference pages for these methods have no examples for it (one exception: https://processing.org/reference/mouseWheel_.html).

Suggested correction

Suggestion 1:

  • Add reference pages for these classes.

  • Add a few examples of their use.

Suggestion 2:

  • describe that for all practical end-user scenarios the global variables (like mouseX, mousePressed, key, keyCode, etc.) contain all necessary information; in that case, I would suggest to even remove the methods taking an event from the documentation.

  • mouseWheel() could be exception: the getCount() method is not backed by a global.

Language

EN

Screenshots or references

No response

Additional context

No response

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions