Skip to content

Commit

Permalink
Deploying to documentation from @ e3fb1c6 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
Torwent committed Dec 26, 2023
1 parent ef5e610 commit 3d99fe9
Show file tree
Hide file tree
Showing 75 changed files with 272 additions and 445 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/rsfishinghandler.doctree
Binary file not shown.
Binary file modified .doctrees/walker.doctree
Binary file not shown.
Binary file modified .doctrees/walkerobjects.doctree
Binary file not shown.
130 changes: 65 additions & 65 deletions _sources/rsfishinghandler.rst.txt
Original file line number Diff line number Diff line change
@@ -1,100 +1,100 @@

RSFishingHandler
TRSFishingHandler
================
RSFishingHandler is a full color fishing bot that is highly customizable.
TRSFishingHandler is a full color fishing bot that is highly customizable.


------------

RSFishingHandler.Setup
~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.Setup
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
procedure RSFishingHandler.Setup(); static;
procedure TRSFishingHandler.Setup();
Resets RSFishingHandler to the non fishing state.
Resets TRSFishingHandler to the non fishing state.
This will:
- Pause RSFishingHandler.Timer;
- Reset RSFishingHandler.CurrentSpot;
- Set RSFishingHandler.IsFishing to False;
- Pause TRSFishingHandler.Timer;
- Reset TRSFishingHandler.CurrentSpot;
- Set TRSFishingHandler.IsFishing to False;


------------

RSFishingHandler.Reset
~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.Reset
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
procedure RSFishingHandler.Reset(); static;
procedure TRSFishingHandler.Reset();
Resets RSFishingHandler to the non fishing state.
Resets TRSFishingHandler to the non fishing state.
This will:
- Pause RSFishingHandler.Timer;
- Reset RSFishingHandler.CurrentSpot;
- Set RSFishingHandler.IsFishing to False;
- Pause TRSFishingHandler.Timer;
- Reset TRSFishingHandler.CurrentSpot;
- Set TRSFishingHandler.IsFishing to False;


------------

RSFishingHandler.GetMMShoreLine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.GetMMShoreLine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.GetMMShoreLine(): TPointArray; static;
function TRSFishingHandler.GetMMShoreLine(): TPointArray;
Get the shore lines on the minimap.

Example
-------
.. code-block:: pascal
ShowOnClient(RSFishingHandler.GetMMShoreLine());
ShowOnClient(TRSFishingHandler.GetMMShoreLine());
------------

RSFishingHandler.GetMSShoreLine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.GetMSShoreLine
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.GetMSShoreLine(): TPointArray; static;
function TRSFishingHandler.GetMSShoreLine(): TPointArray;
Get the shore lines on the mainscreen.

Example
-------
.. code-block:: pascal
ShowOnClient(RSFishingHandler.GetMSShoreLine());
ShowOnClient(TRSFishingHandler.GetMSShoreLine());
------------

RSFishingHandler.FindWaterDirection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.FindWaterDirection
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.FindWaterDirection(): TRectangle; static;
function TRSFishingHandler.FindWaterDirection(): TRectangle;
Finds the adjacent tile that is directly close to the player that has water.

Example
-------
.. code-block:: pascal
ShowOnClient(RSFishingHandler.FindWaterDirection(), False);
ShowOnClient(TRSFishingHandler.FindWaterDirection(), False);
------------

RSFishingHandler.FindSpot
~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.FindSpot
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.FindSpot(out atpa: T2DPointArray; waitTime: Int32 = 350): Boolean; static;
function TRSFishingHandler.FindSpot(out atpa: T2DPointArray; waitTime: Int32 = 350): Boolean;
.. code-block:: pascal
function RSFishingHandler.FindSpot(): Boolean; static; overload;
function TRSFishingHandler.FindSpot(): Boolean; overload;
Find fishing spots on the mainscreen. Optionally return at ATPA of the found spots.

Expand All @@ -105,21 +105,21 @@ Example
var
atpa: T2DPointArray;
begin
if RSFishingHandler.FindSpot(atpa) then //RSFishingHandler.FindSpot() returns true/false.
if TRSFishingHandler.FindSpot(atpa) then //TRSFishingHandler.FindSpot() returns true/false.
ShowOnClient(atpa);
end;
------------

RSFishingHandler.WaitSpot
~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.WaitSpot
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.WaitSpot(out atpa: T2DPointArray; waitTime: Int32 = 350): Boolean; static;
function TRSFishingHandler.WaitSpot(out atpa: T2DPointArray; waitTime: Int32 = 350): Boolean;
.. code-block:: pascal
function RSFishingHandler.WaitSpot(): Boolean; static; overload;
function TRSFishingHandler.WaitSpot(): Boolean; overload;
Wait for fishing spots on the mainscreen. Optionally return at ATPA of the found spots.

Expand All @@ -130,103 +130,103 @@ Example
var
atpa: T2DPointArray;
begin
if RSFishingHandler.WaitSpot(atpa) then //RSFishingHandler.FindSpot() returns true/false.
if RSFishingHandler.WaitSpot(atpa) then //TRSFishingHandler.FindSpot() returns true/false.
ShowOnClient(atpa);
end;
------------

RSFishingHandler.SpotMoved
~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.SpotMoved
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.SpotMoved(out atpa: T2DPointArray): Boolean; static;
function TRSFishingHandler.SpotMoved(out atpa: T2DPointArray): Boolean;
.. code-block:: pascal
function RSFishingHandler.SpotMoved(): Boolean; static; overload;
function TRSFishingHandler.SpotMoved(): Boolean; overload;
Check if RSFishingHandler.CurrentSpot moved.
Check if TRSFishingHandler.CurrentSpot moved.

Example
-------
.. code-block:: pascal
WriteLn RSFishingHandler.SpotMoved();
WriteLn TRSFishingHandler.SpotMoved();
------------

RSFishingHandler._StoppedFishing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler._StoppedFishing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler._StoppedFishing(): Boolean; static;
function TRSFishingHandler._StoppedFishing(): Boolean;
Internal helper method to check for quick things that guarantee us we are not fishing anymore.


------------

RSFishingHandler.CheckFishing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.CheckFishing
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.CheckFishing(out atpa: T2DPointArray): Boolean; static;
function TRSFishingHandler.CheckFishing(out atpa: T2DPointArray): Boolean;
.. code-block:: pascal
function RSFishingHandler.CheckFishing(): Boolean; static; overload;
function TRSFishingHandler.CheckFishing(): Boolean; overload;
Check if we are still fishing. This function could give false positives but it's extremely unlikely.
To determine if we are still fishing it does the following:
- Check if RSFishingHandler.CurrentSpot (which is the last spot we clicked) has moved.
- Check if TRSFishingHandler.CurrentSpot (which is the last spot we clicked) has moved.
- Check if the inventory is full.
- Check if we leveled up.
- Check if RSFishingHandler.Timer has reached it's end. The time lasts anywhere between 40 seconds and 70 seconds randomly
- Check if TRSFishingHandler.Timer has reached it's end. The time lasts anywhere between 40 seconds and 70 seconds randomly
and it's reset everytime this is called and we earned XP.

Example
-------
.. code-block:: pascal
WriteLn RSFishingHandler.CheckFishing();
WriteLn TRSFishingHandler.CheckFishing();
------------

RSFishingHandler.FacingWater
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.FacingWater
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.FacingWater(): Boolean; static;
function TRSFishingHandler.FacingWater(): Boolean;
Check if we have water directly north, west, south or east of us.

Example
-------
.. code-block:: pascal
WriteLn RSFishingHandler.FacingWater();
WriteLn TRSFishingHandler.FacingWater();
------------

RSFishingHandler.ClickSpot
~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSFishingHandler.ClickSpot
~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function RSFishingHandler.ClickSpot(out atpa: T2DPointArray): Boolean; static;
function RSFishingHandler.ClickSpot(): Boolean; static; overload;
function TRSFishingHandler.ClickSpot(out atpa: T2DPointArray): Boolean;
function TRSFishingHandler.ClickSpot(): Boolean; overload;
Click the closest fishing spot to the player and switches RSFishingHandler to "IsFishing".
We can check if we are still fishing with RSFishingHandler.CheckFishing().
Click the closest fishing spot to the player and switches TRSFishingHandler to "IsFishing".
We can check if we are still fishing with TRSFishingHandler.CheckFishing().

Example
-------
.. code-block:: pascal
RSFishingHandler.ClickSpot();
TRSFishingHandler.ClickSpot();
------------
Loading

0 comments on commit 3d99fe9

Please sign in to comment.