SRL Archive - Development

At the moment I've written a small example on how the Mufasa PS Handbook will look like. It will basically be a book with a description of every single function that we export to Pascal Script. It will be spread in HTML and PDF form.

See it in action here: Mufasa Handbook in HTML

As you can see, it is far from done. Currently it isn't auto generated, and I don't see it being auto generated any time soon. (I've done it in the past for mufasa v1, but it just doesn't look as neat as when people write it)

Soo…. If you feel like learning a bit of \LaTeX, you can help documenting.

EDIT: This handbook will be about the exported functions. (EG: The ones exported to pascalscript)
I also made a html file of mufasa_intro. Mufasa Intro in HTML

The actual FPC/Mufasa handbook will be auto generated.

I've decided to try and host most mufasa related stuff on my sheevaplug;

HTML:
http://vila.villavu.com/mufasa/mufasa_ps_handbook/
http://vila.villavu.com/mufasa/mufasa_intro/

PDF:
http://vila.villavu.com/mufasa/mufasa_ps_handbook.pdf
http://vila.villavu.com/mufasa/mufasa_intro.pdf

It currently updates svn and rebuilds the doc every hour.

E: It now also syncs the mufasa svn every hour… Just in case. :p

From: Wizzup?
E: It now also syncs the mufasa svn every hour… Just in case. :p

Are you sure it does that correctly without rm -rvf'ing everything? Last time you tried to sync some repos it didn't work out too well…

From: Markus
Are you sure it does that correctly without rm -rvf'ing everything? Last time you tried to sync some repos it didn't work out too well…

Actually, that was when building snapshots.
Also, this runs as a separate user, so even if I totally fucked up, worst it can do is remove the scripts that fuck up + the sync.

27c27
< TClickType, which, as the name suggests, defines the click type.
—
> TClickType, which defines the click type.
45c45
< {in x, y: }}{\color{typeGreen}{Integer}})
—
> {in x, y: }}{\color{typeGreen}{Integer}});
51c51
< {out x, y: }}{\color{typeGreen}{Integer}})
—
> {out x, y: }}{\color{typeGreen}{Integer}});
53c53
< GetMousePos returns the current position of the mouse in X and Y.
—
> GetMousePos returns the current position of the mouse in x and y.
58c58
< {\color{typeGreen}{clickType}})
—
> {\color{typeGreen}{TClickType}});
60,61c60,61
< 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
—
> HoldMouse holds the given mouse button (clickType) down at the specified x, y
> coordinate. If the mouse is not at the given x, y yet, the mouse position
67c67
< {\color{typeGreen}{clickType}})
—
> {\color{typeGreen}{TClickType}});
69c69
< ReleaseMouse releases the given mouse button (clickType) at the specified x,y
—
> ReleaseMouse releases the given mouse button (clickType) at the specified x, y
76c76
< {\color{typeGreen}{clickType}})
—
> {\color{typeGreen}{TClickType}});
84c84
< Most of them are quite basic, and can use some improvement.
—
> Most of them are quite basic and can use some improvement.
283c283
< 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,
288,291d287
< 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.
<
294a291,294
> 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.
>
304c304
< \textbf{procedure} {\color{blue}{SendKEys}}({\color{typeRed}
—
> \textbf{procedure} {\color{blue}{SendKeys}}({\color{typeRed}
307c307
< 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
314c314
< IsKeyDown returns true if then give VK key is ``down''.
—
> IsKeyDown returns true if the given VK key is ``down''.
330a331,338
> \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.
>
332a341,349
> \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.
>
334a352,361
> \textbf{function} {\color{blue}{FindColorsTolerance}}({\color{typeRed}
> {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.
>
>
342c369
< objects. One can specify several points, and colours and tolerances
—
> objects. One can specify several points, colours and tolerances
379c406
< 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.

Added, and fixed a few typo's. ;)

Thankful to mixster for his additions. My english is not good enough to write decent documentation. There's a lot to write, and I want to do it fast, so if you run into even the slightest spelling/grammatical/fatal(:p) error, please correct it.