moparisthebest/Simba
1
0
Fork 0
mirror of https://github.com/moparisthebest/Simba synced 2025-02-07 02:30:19 -05:00
Code Issues Releases Wiki Activity

Documentation fixes and additions by mixster.

Browse Source 
git-svn-id: http://www.villavu.com/repositories/merlijn/mufasa@256 3f818213-9676-44b0-a9b4-5e4c4e03d09d
This commit is contained in:
Wizzup? 2009-11-30 23:56:54 +00:00
parent a09b1d0043
commit a01c08c30b
1 changed files with 48 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

71
Doc/mufasa_ps_handbook.tex
View File

@ -24,7 +24,7 @@ HOI DIT IS DE MUFASA FUNCTIE LIJST!
A few variables are exported for working with Mufasa Mouse Functions.
TClickType, which, as the name suggests, defines the click type.
TClickType, which defines the click type.
\begin{itemize}
\item $mouse\_Right = 0$
\item $mouse\_Left = 1$
@ -42,38 +42,38 @@ TMousePress, which defines if the mouse button is to be down or up.
\subsection{MoveMouse}
\textbf{procedure} {\color{blue}{MoveMouse}}({\color{typeRed}
{in x, y: }}{\color{typeGreen}{Integer}})
{in x, y: }}{\color{typeGreen}{Integer}});
MoveMouse moves the mouse pointer to the specified x and y coordinates.
\subsection{GetMousePos}
\textbf{procedure} {\color{blue}{GetMousePos}}({\color{typeRed}
{out x, y: }}{\color{typeGreen}{Integer}})
{out x, y: }}{\color{typeGreen}{Integer}});
GetMousePos returns the current position of the mouse in X and Y.
GetMousePos returns the current position of the mouse in $x$ and $y$.
\subsection{HoldMouse}
\textbf{procedure} {\color{blue}{HoldMouse}}({\color{typeRed}
{x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}{clickType :}}
{\color{typeGreen}{clickType}})
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.
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$.
\subsection{ReleaseMouse}
\textbf{procedure} {\color{blue}{ReleaseMouse}}({\color{typeRed}
{x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}{clickType :}}
{\color{typeGreen}{clickType}})
{\color{typeGreen}{clickType}});
ReleaseMouse releases the given mouse button (clickType) 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 releases the given mouse button (clickType) 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$.
\subsection{ClickMouse}
\textbf{procedure} {\color{blue}{ClickMouse}}({\color{typeRed}
{x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}{clickType :}}
{\color{typeGreen}{clickType}})
{\color{typeGreen}{clickType}});
ClickMouse performs a click with the given mouse button (clickType) at the
specified x, y coordinate.
@ -81,7 +81,7 @@ specified x, y coordinate.
\section{Keyboard}
The Keyboard functions in Mufasa are listed here.
Most of them are quite basic, and can use some improvement.
Most of them are quite basic and can use some improvement.
\subsection{Types}
@ -276,21 +276,20 @@ Virtual Keys also work on non-Windows operating systems.
KeyDown sends a request to the Operating System to ``fake'' an event that
causes the Key to be ``down''.
``key'' can be any Virtual Key\footnote{See the section on Virtual Keys}.
$key$ can be any Virtual Key\footnote{See the section on Virtual Keys}.
\subsubsection{Common pitfalls}
Don't forget that certain keys may require that shift, or another key
Don't forget that certain keys may require that shift, or another key,
is down as well.
\subsection{KeyUp}
\textbf{procedure} {\color{blue}{KeyUp}}({\color{typeRed}
{key: }}{\color{typeGreen}{Word}});
KeyUp sends a request to the Operating System to ``fake'' an event that
causes the Key to be ``up''.
``key'' can be any Virtual Key.
\textbf{procedure} {\color{blue}{KeyUp}}({\color{typeRed}
{key: }}{\color{typeGreen}{Word}});
$key$ can be any Virtual Key.
\subsection{PressKey}
@ -304,14 +303,14 @@ PressKey combines KeyDown and KeyUp, to fake a key press.
\textbf{procedure} {\color{blue}{SendKEys}}({\color{typeRed}
{s: }}{\color{typeGreen}{String}});
SendKeys takes a string ``s'', and attempts to send it's complete contents to
SendKeys takes a string $s$, and attempts to send it's complete contents to
the client. It currently only accepts characters ranging from ``A..z''.
\subsection{IsKeyDown}
\textbf{function} {\color{blue}{PressKey}}({\color{typeRed}
{key: }}{\color{typeGreen}{Word}}): {\color{typeGreen}{Boolean}};
IsKeyDown returns true if then give VK key is ``down''.
IsKeyDown returns true if the given VK key is ``down''.
\subsection{Notes}
@ -328,10 +327,36 @@ result of IsKeyDown:
\subsection{FindColor}
\textbf{function} {\color{blue}{FindColor}}({\color{typeRed}
{var x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}
{col, x1, y1, x2, y2: }}{\color{typeGreen}{Integer}}): {\color{typeGreen}{Boolean}};
FindColor returns true if the exact color given (col) is found in the box defined by x1, y1, x2, y2.
The point is returned in x and y. It searches from the top left to the bottom right and will stop
after matching a point.
\subsection{FindColorTolerance}
\textbf{function} {\color{blue}{FindColorTolerance}}({\color{typeRed }
{var x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}
{col, x1, y1, x2, y2, tol: }}{\color{typeGreen}{Integer}}): {\color{typeGreen}{Boolean}};
FindColorTolerance returns true if a colour within the given tolerance range (tol) of the given color (col)
is found in the box defined by x1, y1, x2, y2. Only the first point is returned in x and y.
Whether or not a color is within the tolerance range is determined by the CTS mode.
It searches from the top left to the bottom right and will stop after matching a point.
\subsection{FindColorsTolerance}
\textbf{function} {\color{blue}{FindColorsTolerance}}({\color{typeRe d}
{var pts: }}{\color{typeGreen}{TPointArray}}; {\color{tyepTred}
{col, x1, y1, x2, y2, tol: }}{\color{typeGreen}{Integer}}): {\color{typeGreen}{Boolean}};
FindColorsTolerance returns true if at least one point was found. A point is found if it is within the
given tolerance range (tol) of the given color (col) and inside the box defined by x1, y1, x2, y2.
Whether or not a color is within the tolerance range is determined by the CTS mode.
It searches from the top left to the bottom right and will find all matching points in the area.
\section{Bitmaps}
% Dit doe je zelf maar
@ -339,7 +364,7 @@ result of IsKeyDown:
\section{DTMs}
Deformable Template Models are a special approach to finding
objects. One can specify several points, and colours and tolerances
objects. One can specify several points, colours and tolerances
for these points.
\subsection{Types}
@ -376,7 +401,7 @@ Deprecated DTM type:
FindDTM is the most basic DTM finding function. It takes a box to search in,
and if the DTM is found, it will set $x$ and $y$ to the coordinate the DTM
was found it, and it will also return true. Else, it returns false.
was found at and it will also return true. Else, it returns false.
Once a DTM is found, it will stop searching. In other words; it always returns
the first found DTM.