len0rd/suit
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Document new GUI state getters

Browse source
This commit is contained in:
Matthias Richter 2016-08-28 19:20:49 +02:00
parent c66bbe9065
commit 549693dd38
1 changed files with 50 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

80
docs/core.rst
View file

@ -46,6 +46,56 @@ Forwards a ``love.keypressed(key)`` event to SUIT.
Forwards a ``love.textinput(key)`` event to SUIT. Forwards a ``love.textinput(key)`` event to SUIT.
GUI State
^^^^^^^^^
.. function:: anyHovered()
:returns: ``true`` if any widget is hovered by the mouse.
Checks if any widget is hovered by the mouse.
.. function:: isHovered(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget is hovered by the mouse.
Checks if the widget identified by ``id`` is hovered by the mouse.
.. function:: wasHovered(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget was in the hovered by the mouse in the last frame.
Checks if the widget identified by ``id`` was hovered by the mouse in the last frame.
.. function:: anyActive()
:returns: ``true`` if any widget is in the ``active`` state.
Checks whether the mouse button is pressed and held on any widget.
.. function:: isActive(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget is in the ``active`` state.
Checks whether the mouse button is pressed and held on the widget identified by ``id``.
.. function:: anyHit()
:returns: ``true`` if the mouse was pressed and released on any widget.
Check whether the mouse was pressed and released on any widget.
.. function:: isHit(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the mouse was pressed and released on the widget.
Check whether the mouse was pressed and released on the widget identified by ``id``.
Internal Helpers Internal Helpers
---------------- ----------------
@ -73,36 +123,6 @@ Prepares GUI state when entering a frame.
Clears GUI state when exiting a frame. Clears GUI state when exiting a frame.
GUI State
^^^^^^^^^
.. function:: anyHovered()
:returns: ``true`` if any widget is hovered by the mouse.
Checks if any widget is hovered by the mouse.
.. function:: isHovered(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget is hovered by the mouse.
Checks if the widget identified by ``id`` is hovered by the mouse.
.. function:: wasHovered(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget was in the hovered by the mouse in the last frame.
Checks if the widget identified by ``id`` was hovered by the mouse in the last frame.
.. function:: isActive(id)
:param mixed id: Identifier of the widget.
:returns: ``true`` if the widget is in the ``active`` state.
Checks whether the mouse button is pressed on the widget identified by ``id``.
Mouse Input Mouse Input
^^^^^^^^^^^ ^^^^^^^^^^^