Skip to content

Commit 09a0904

Browse files
committed
added more clarity to the docs regarding the "clicks" attribute
1 parent 9d9e84d commit 09a0904

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

docs/reST/ref/event.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,11 @@ specific attributes.
8787

8888
.. versionchangedold:: 2.0.1 The ``unicode`` attribute was added to ``KEYUP`` event.
8989

90+
.. versionchangedold:: 2.5.7 The ``clicks`` attribute was added to ``MOUSEBUTTONDOWN`` and ``MOUSEBUTTONUP`` events.
91+
92+
The ``clicks`` attribute of the ``MOUSEBUTTONDOWN`` and ``MOUSEBUTTONUP`` events indicate the number of clicks occurring
93+
in rapid succession, e.g. ``1`` for single-click, ``2`` for double-click, etc.
94+
9095
Note that ``ACTIVEEVENT``, ``VIDEORESIZE`` and ``VIDEOEXPOSE`` are considered
9196
as "legacy" events, the use of pygame2 ``WINDOWEVENT`` API is recommended over
9297
the use of this older API.

0 commit comments

Comments
 (0)