From ce60d6239214d58a530da9f18932c95fd5921ca0 Mon Sep 17 00:00:00 2001
From: Merlijn Wajer <merlijn@wizzup.org>
Date: Sun, 27 Jun 2010 17:47:41 +0200
Subject: [PATCH] Colourfinding initial doc

---
 Doc/sphinx/referencescript.rst         |  1 +
 Doc/sphinx/scriptref/colourfinding.rst | 56 ++++++++++++++++++++++++++
 2 files changed, 57 insertions(+)
 create mode 100644 Doc/sphinx/scriptref/colourfinding.rst

diff --git a/Doc/sphinx/referencescript.rst b/Doc/sphinx/referencescript.rst
index 0346f14..006bb49 100644
--- a/Doc/sphinx/referencescript.rst
+++ b/Doc/sphinx/referencescript.rst
@@ -11,4 +11,5 @@ default (Pascal) engine.
 .. toctree::
 
     scriptref/mouseandkeyboard.rst
+    scriptref/colourfinding.rst
     scriptref/files.rst
diff --git a/Doc/sphinx/scriptref/colourfinding.rst b/Doc/sphinx/scriptref/colourfinding.rst
new file mode 100644
index 0000000..ad9484b
--- /dev/null
+++ b/Doc/sphinx/scriptref/colourfinding.rst
@@ -0,0 +1,56 @@
+Colour Finding
+==============
+
+Finding colours on the screen is quite simple. Simba offers methods like
+``FindColor`` to locate colours on the screen.
+
+.. note::
+
+    Although the documentation uses follows the ``English`` spelling of 
+    ``colour``; the code for compatibility sake uses ``color``, without the u.
+
+Colour Finding Methods
+----------------------
+
+A list of (not yet all) colour finding methods in Simba.
+
+FindColor
+~~~~~~~~~
+
+.. code-block:: pascal
+
+    function FindColor(var x, y: Integer; col, x1, y1, x2, y2: Integer): 
+    Boolean;
+
+
+FindColor returns true if the exact colour 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.
+
+FindColorTolerance
+~~~~~~~~~~~~~~~~~~
+
+.. code-block:: pascal
+
+    function FindColorTolerance(var x, y: Integer; col, x1, y1, x2, y2, tol: 
+    Integer): Boolean; 
+
+FindColorTolerance returns true if a colour within the given tolerance range 
+(tol) of the given colour (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 colour is within the tolerance range is determined by the :ref:`CTS` mode.
+It searches from the top left to the bottom right and will stop after matching a point.
+
+
+FindColorsTolerance
+~~~~~~~~~~~~~~~~~~~
+
+.. code-block:: pascal
+
+    function FindColorsTolerance( out pts: TPointArray; col, x1, y1, x2, y2, 
+    tol: Integer): 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.