mirror of
https://github.com/moparisthebest/Simba
synced 2025-02-16 07:10:10 -05:00
Example script reference doc. Is this setup O-K?
This commit is contained in:
parent
e2375dc9b7
commit
ede98b2f2c
@ -47,9 +47,9 @@ copyright = u'2010, Merlijn Wajer'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '0.695'
|
||||
version = '0.700'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '0.695'
|
||||
release = '0.700'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
@ -5,4 +5,5 @@ Scripting Reference hoi
|
||||
|
||||
.. toctree::
|
||||
|
||||
scriptref/mouseandkeyboard.rst
|
||||
scriptref/files.rst
|
||||
|
64
Doc/sphinx/scriptref/mouseandkeyboard.rst
Normal file
64
Doc/sphinx/scriptref/mouseandkeyboard.rst
Normal file
@ -0,0 +1,64 @@
|
||||
Mouse and Keyboard
|
||||
==================
|
||||
|
||||
Types
|
||||
-----
|
||||
|
||||
A few variables are exported for working with Mufasa Mouse Functions.
|
||||
|
||||
TClickType, which defines the click type.
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
const
|
||||
mouse_Right = 0
|
||||
mouse_Left = 1
|
||||
mouse_Middle = 2
|
||||
|
||||
TMousePress, which defines if the mouse button is to be down or up.
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
TMousePress = (mouse_Down, mouse_Up);
|
||||
|
||||
MoveMouse
|
||||
~~~~~~~~~
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
procedure MoveMouse(x, y: integer);
|
||||
|
||||
MoveMouse moves the mouse pointer to the specified x and y coordinates.
|
||||
|
||||
GetMousePos
|
||||
~~~~~~~~~~~
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
procedure GetMousePos(var x, y: integer);
|
||||
|
||||
GetMousePos returns the current position of the mouse in x and
|
||||
y.
|
||||
|
||||
|
||||
HoldMouse
|
||||
~~~~~~~~~
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
procedure HoldMouse(x, y: Integer; clickType: TClickType);
|
||||
|
||||
HoldMouse holds the given mouse button (clickType) down at the specified
|
||||
x, y coordinate. If the mouse if not at the given x, y yet, the mouse position
|
||||
will be set to x, y.
|
||||
|
||||
ReleaseMouse
|
||||
~~~~~~~~~~~~
|
||||
|
||||
.. code-block:: pascal
|
||||
|
||||
procedure ReleaseMouse(x, y: Integer; clickType: TClickType);
|
||||
|
||||
HoldMouse holds the given mouse button (clickType) down at the specified
|
||||
x, y coordinate. If the mouse if not at the given x, y yet, the
|
||||
mouse position will be set to x, y.
|
@ -17,5 +17,4 @@ Changelog for X.XXX::
|
||||
- Did some stuff
|
||||
- Important note about stuff here.
|
||||
- Other stuff
|
||||
- Jesus Christ even more stuff!
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user