From 352979fbf8634ed33a138001926d180ee89d9b21 Mon Sep 17 00:00:00 2001 From: Nava2 Date: Thu, 4 Feb 2010 05:50:51 +0000 Subject: [PATCH] More manual stuff, just updated the rest of them using the new functions, also I think that having a pvtotal command would be nice. Anyways, sorry if some are messed up, I did my best. git-svn-id: http://www.villavu.com/repositories/merlijn/mufasa@518 3f818213-9676-44b0-a9b4-5e4c4e03d09d --- trunk/Doc/mufasa_ps_handbook.tex | 58 +++++++++++++------------------- 1 file changed, 23 insertions(+), 35 deletions(-) diff --git a/trunk/Doc/mufasa_ps_handbook.tex b/trunk/Doc/mufasa_ps_handbook.tex index ca67fdc..ff56c86 100644 --- a/trunk/Doc/mufasa_ps_handbook.tex +++ b/trunk/Doc/mufasa_ps_handbook.tex @@ -17,6 +17,7 @@ \newcommand{\pvtypel}[1]{{\color{typeGreen}{#1}}} \newcommand{\pvname}[1]{{\color{typeRed}{#1}}:} \newcommand{\mname}[1]{{\color{blue}{#1}}} +\newcommand{\pvtotal}[2]{{\pvname{#1}} {\pvtype{#2}}} %this might be better? \maketitle @@ -135,14 +136,12 @@ TMousePress, which defines if the mouse button is to be down or up. % TMousePress = (mouse_Down, mouse_Up); \subsection{MoveMouse} -\textbf{procedure} {\color{blue}{MoveMouse}}({\color{typeRed} -{in x, y: }}{\color{typeGreen}{Integer}}); +\pproc \mname{MoveMouse}(\textbf{in } \pvname{x, y} \pvtypel{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}}); +\pproc \mname{GetMousePos}(\textbf{out } \pvname{x, y} \pvtypel{Integer}); GetMousePos returns the current position of the mouse in \textbf{x} and \textbf{y}. @@ -156,18 +155,15 @@ coordinate. If the mouse if not at the given \textbf{x}, \textbf{y} yet, the mou will be set to \textbf{x}, \textbf{y}. \subsection{ReleaseMouse} -\textbf{procedure} {\color{blue}{ReleaseMouse}}({\color{typeRed} -{x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}{clickType :}} -{\color{typeGreen}{TClickType}}); +\pproc \mname{ReleaseMouse}(\pvname{x, y} \pvtype{Integer} \pvname{clickType} \pvtypel{TClickType}); ReleaseMouse releases the given mouse button (clickType) at the specified \textbf{x}, \textbf{y} coordinate. If the mouse if not at the given \textbf{x}, \textbf{y} yet, the mouse position will be set to \textbf{x}, \textbf{y}. \subsection{ClickMouse} -\textbf{procedure} {\color{blue}{ClickMouse}}({\color{typeRed} -{x, y: }}{\color{typeGreen}{Integer}}; {\color{typeRed}{clickType :}} -{\color{typeGreen}{TClickType}}); +\pproc \mname{ClickMouse}(\pvname{x, y} \pvtype{Integer} \pvname{clickType} +\pvtypel{TClickType}); ClickMouse performs a click with the given mouse button (clickType) at the specified x, y coordinate. @@ -365,8 +361,7 @@ Virtual Keys also work on non-Windows operating systems. \subsection{KeyDown} -\textbf{procedure} {\color{blue}{KeyDown}}({\color{typeRed} -{key: }}{\color{typeGreen}{Word}}); +\pproc \mname{KeyDown}(\pvname{key} \pvtypel{Word}); KeyDown sends a request to the Operating System to ``fake'' an event that causes the Key to be ``down''. @@ -378,8 +373,7 @@ 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}}); +\pproc \mname{KeyUp}(\pvname{key} \pvtypel{Word}); KeyUp sends a request to the Operating System to ``fake'' an event that causes the Key to be ``up''. @@ -387,22 +381,19 @@ causes the Key to be ``up''. \subsection{PressKey} -\textbf{procedure} {\color{blue}{PressKey}}({\color{typeRed} -{key: }}{\color{typeGreen}{Word}}); +\pproc \mname{PressKey}(\pvname{key} \pvtypel{Word}); PressKey combines KeyDown and KeyUp, to fake a key press. \subsection{SendKeys} -\textbf{procedure} {\color{blue}{SendKEys}}({\color{typeRed} -{s: }}{\color{typeGreen}{String}}); +\pproc \mname{SendKeys}(\pvname{s} \pvtypel{String}); SendKeys takes a string \textbf{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}}; +\pfunc \mname{PressKey}(\pvname{key} \pvtypel{Word}): \pvtype{Boolean} IsKeyDown returns true if the given VK key is ``down''. @@ -421,9 +412,8 @@ 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}}; +\pfunc \mname{FindColor}}(\textbf{out} \pvname{x, y} \pvtype{Integer} \pvname{col, x1, y1, x2, y2} +\pvtypel{Integer}): \pvtype{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 @@ -431,9 +421,8 @@ 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}}; +\pfunc \mname{FindColorTolerance}(\textbf{out} \pvname{x, y: } \pvtype{Integer} +\pvname{col, x1, y1, x2, y2, tol: }\pvtypel{Integer}): \pvtype{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. @@ -442,9 +431,8 @@ It searches from the top left to the bottom right and will stop after matching a \subsection{FindColorsTolerance} -\textbf{function} {\color{blue}{FindColorsTolerance}}({\color{typeRed} -{var pts: }}{\color{typeGreen}{TPointArray}}; {\color{typeRed} -{col, x1, y1, x2, y2, tol: }}{\color{typeGreen}{Integer}}): {\color{typeGreen}{Boolean}}; +\pfunc \mname{FindColorsTolerance}( \textbf{out }\pvname{pts} \pvtype{TPointArray} \pvname +{col, x1, y1, x2, y2, tol} \pvtypel{Integer}): \pvtype{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. @@ -493,7 +481,7 @@ Deprecated DTM type: \subsection{FindDTM} -\pfunc \mname{FindDTM}(\pvname{DTM: }\pvtype{Integer} \textbf{var} +\pfunc \mname{FindDTM}(\pvname{DTM}\pvtype{Integer} \textbf{out} \pvname{x, y} \pvtype{Integer} \pvname{x1, y1, x2, y2} \pvtypel{Integer}): \pvtype{Boolean} @@ -505,7 +493,7 @@ the first found DTM. \subsection{FindDTMs} -\pfunc \mname{FindDTMs}(\pvname{DTM}\pvtype{Integer} \pvname{Points} +\pfunc \mname{FindDTMs}(\pvname{DTM}\pvtype{Integer} \textbf{out} \pvname{Points} \pvtype{TPointArray} \pvname{x1, y1, x2, y2} \pvtypel{Integer}): \pvtype{Boolean} @@ -513,9 +501,9 @@ FindDTMs is like FindDTM, but it returns an array of \textbf{x} and \textbf{y}, \textbf{TPointArray} type. \subsection{FindDTMRotated} -\pfunc \mname{FindDTMRotated}(\pvname{DTM}\pvtype{Integer} \textbf{var} +\pfunc \mname{FindDTMRotated}(\pvname{DTM}\pvtype{Integer} \textbf{out } \pvname{x, y} \pvtype{Integer} \pvname{x1, y1, x2, y2} \pvtype{Integer} -\pvname{sAngle, eAngle, aStep} \pvtype{Extended} \textbf{var} +\pvname{sAngle, eAngle, aStep} \pvtype{Extended} \textbf{out} \pvname{aFound} \pvtypel{Extended}): \pvtype{Boolean} FindDTMRotated is behaves like FindDTM. Only, it will turn the DTM between @@ -525,7 +513,7 @@ at. \subsection{FindDTMsRotated} \pfunc \mname{FindDTMRotated}(\pvname{DTM}\pvtype{Integer} \textbf{var} \pvname{Points} \pvtype{TPointArray} \pvname{x1, y1, x2, y2} \pvtype{Integer} -\pvname{sAngle, eAngle, aStep} \pvtype{Extended} \textbf{var} +\pvname{sAngle, eAngle, aStep} \pvtype{Extended} \textbf{out} \pvname{aFound} \pvtypel{T2DExtendedArray}): \pvtype{Boolean} FindDTMRotated is behaves like FindDTMs. Only, it will turn the DTM between @@ -651,7 +639,7 @@ Wizzyplugin stuff Nothing here! Do you really think we document Easter eggs? ???? -Hakuna matata! +HakunaMatata!