Skip to content

Commit

Permalink
Deploying to documentation from @ bd7c06b 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@Torwent
Torwent committed Sep 17, 2023
1 parent b7b1e6a commit 61b0865
Show file tree
Hide file tree
Showing 6 changed files with 113 additions and 371 deletions.
Binary file modified .doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified .doctrees/walkerobjects.doctree
View file
Binary file not shown.
203 changes: 34 additions & 169 deletions _sources/walkerobjects.rst.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -368,16 +368,14 @@ Example
------------

TRSObject._AsyncHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSObject._UpdateTarget
~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
procedure TRSObject._UpdateTarget(sender: PMouse; var x, y: Double; var done: Boolean);
function TRSObject._AsyncHoverHelper(): Boolean;
function TRSObject._AsyncHoverHelper(attempts: Int32): Boolean; overload;
Internal helper methods used to hover a TRSObject target asynchronously.
You should not use this directly.
Internal helper method of TMouseMovingEventEx type used to update the target position while the mouse is moving.
You should probably not touch this if you don't understand it.


------------
Expand All @@ -386,87 +384,43 @@ TRSObject._HoverHelper
~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject._HoverHelper(attempts: Int32): Boolean;
function TRSObject._HoverHelper(attempts: Int32; trackTarget: Boolean): Boolean;
Internal helper method used to hover a TRSObject target.
You should not use this directly.


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

TRSObject._AsyncWalkHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject._AsyncWalkHoverHelper(attempts: Int32): Boolean;
Internal helper method used to walk and hover a TRSObject target asynchronously.
You should not use this directly.

This is responsible for deciding wether we should walk to a TRSObject target or not before attempting to hover it asynchronously.


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

TRSObject._WalkHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject._WalkHoverHelper(attempts: Int32): Boolean;
function TRSObject._WalkHoverHelper(attempts: Int32; trackTarget: Boolean): Boolean;
Internal helper method used to walk and hover a TRSObject target.
You should not use this directly.

This is responsible for deciding wether we should walk to a TRSObject target or not before attempting to hover it.


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

TRSObject.AsyncHover
~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject.AsyncHover(): Boolean;
Method used to asynchronously hover a TRSObject target if it's found on the mainscreen.
AsyncMouse is very powerful but you shouldn't use it without a good reason for it.

Example
-------
.. code-block:: pascal
RSObjects.GEBank.AsyncHover(); //Be in GE with a walker setup there.
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('Exch');
------------

TRSObject.Hover
~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject.Hover(attempts: Int32 = 2; async: Boolean = True): Boolean;
function TRSObject.Hover(attempts: Int32 = 2; trackTarget: Boolean = TRACK_TARGET): Boolean;
Method used to hover a TRSObject target if it's found on the mainscreen.
It can hover synchronously and asynchronously.
It can update the target position while the mouse moves with **trackTarget**.

Example
-------
.. code-block:: pascal
RSObjects.GEBank.Hover(2, true); //Be in GE with a walker setup there.
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('Exch');
Mouse.Move(Inventory.Bounds());
RSObjects.GEBank.Hover(2, False);
repeat
WriteLn 'This will only print after the mouse has finished moving because it's not asynchronous!';
until MainScreen.IsUpText('Exch');
RSW.WebWalk(WaspWeb.LOCATION_VARROCK);
RSObjects.GEBank.Hover(); //Be in GE with a walker setup there.
------------
Expand All @@ -475,31 +429,18 @@ TRSObject.WalkHover
~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSObject.WalkHover(attempts: Int32 = 2; async: Boolean = True): Boolean;
function TRSObject.WalkHover(attempts: Int32 = 2; trackTarget: Boolean = TRACK_TARGET): Boolean;
Method used to walk and hover a TRSObject target if it's found on the mainscreen after walking.
It can hover synchronously and asynchronously.
Keep in mind the walking portion is not made asynchronously, only the final moments of the method
when it's time to hover the TRSObject target can be made asynchronously.
It can update the target position while the mouse moves with **trackTarget**.

Example
-------
.. code-block:: pascal
//Be in varrock with a varrock map loaded.
rsw.WebWalk(WaspWeb.LOCATION_VARROCK);
RSObjects.GEBank.WalkHover(2, true); //keep in mind that walking is not async.
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('Exch');
rsw.WebWalk(WaspWeb.LOCATION_VARROCK);
RSObjects.GEBank.WalkHover(2, False);
repeat
WriteLn 'This will only print after the mouse has finished moving because it's not asynchronous!';
until MainScreen.IsUpText('Exch');
RSW.WebWalk(WaspWeb.LOCATION_VARROCK);
RSObjects.GEBank.WalkHover();
------------
Expand All @@ -511,7 +452,6 @@ TRSObject.Click
function TRSObject.Click(leftClick: Boolean = True; attempts: Int32 = 2): Boolean;
Method used to click a TRSObject target if it's found on the mainscreen.
This hovers the TRSObject target asynchronously.

Example
-------
Expand All @@ -530,7 +470,6 @@ TRSObject.SelectOption
function TRSObject.SelectOption(action: TStringArray; attempts: Int32 = 2): Boolean;
Method used to select an option on a TRSObject target if it's found on the mainscreen.
This hovers the TRSObject target asynchronously.

Example
-------
Expand All @@ -549,7 +488,6 @@ TRSObject.WalkClick
function TRSObject.WalkClick(leftClick: Boolean = True; attempts: Int32 = 2): Boolean;
Method used to walk and click a TRSObject target if it's found on the mainscreen.
This hovers the TRSObject target asynchronously.

Example
-------
Expand All @@ -568,7 +506,6 @@ TRSObject.WalkSelectOption
function TRSObject.WalkSelectOption(action: TStringArray; attempts: Int32 = 2): Boolean;
Method used to walk and select an option on a TRSObject target if it's found on the mainscreen.
This hovers the TRSObject target asynchronously.

Example
-------
Expand Down Expand Up @@ -749,16 +686,14 @@ Example
------------

TRSMMDot._AsyncHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~~
TRSMMDot._UpdateTarget
~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
procedure TRSMMDot._UpdateTarget(sender: PMouse; var x, y: Double; var done: Boolean);
function TRSMMDot._AsyncHoverHelper(): Boolean;
function TRSMMDot._AsyncHoverHelper(attempts: Int32): Boolean; overload;
Internal helper methods used to hover a TRSMMDot target asynchronously.
You should not use this directly.
Internal helper method of TMouseMovingEventEx type used to update the target position while the mouse is moving.
You should probably not touch this if you don't understand it.


------------
Expand All @@ -767,91 +702,45 @@ TRSMMDot._HoverHelper
~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot._HoverHelper(attempts: Int32): Boolean;
function TRSMMDot._HoverHelper(attempts: Int32; trackTarget: Boolean): Boolean;
Internal helper method used to hover a TRSMMDot target.
You should not use this directly.


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

TRSMMDot._AsyncWalkHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot._AsyncWalkHoverHelper(attempts: Int32): Boolean;
Internal helper method used to walk and hover a TRSMMDot target asynchronously.
You should not use this directly.

This is responsible for deciding wether we should walk to a TRSMMDot target or not before attempting to hover it asynchronously.


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

TRSMMDot._WalkHoverHelper
~~~~~~~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot._WalkHoverHelper(attempts: Int32): Boolean;
function TRSMMDot._WalkHoverHelper(attempts: Int32; trackTarget: Boolean): Boolean;
Internal helper method used to walk and hover a TRSMMDot target.
You should not use this directly.

This is responsible for deciding wether we should walk to a TRSMMDot target or not before attempting to hover it.


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

TRSMMDot.AsyncHover
~~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot.AsyncHover(): Boolean;
Method used to asynchronously hover a TRSMMDot target if it's found on the mainscreen.
AsyncMouse is very powerful but you shouldn't use it without a good reason for it.
NPCs are a good reason because they often move while the mouse is moving towards them.

Example
-------
.. code-block:: pascal
//Be in Lumbridge castle with a walker setup there.
RSNPCs.LumbridgeCook.AsyncHover();
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('Exch');
------------

TRSMMDot.Hover
~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot.Hover(attempts: Int32 = 2; async: Boolean = True): Boolean;
function TRSMMDot.Hover(attempts: Int32 = 2; trackTarget: Boolean = TRACK_TARGET): Boolean;
Method used to hover a TRSMMDot target if it's found on the mainscreen.
It can hover synchronously and asynchronously.
For NPCs that move, asynchronously is highly recommended.
It can update the target position as the mouse moves with **trackTarget**.
For NPCs that move, this is highly recommended.

Example
-------
.. code-block:: pascal
//Be in Lumbridge castle with a walker setup there.
RSNPCs.LumbridgeCook.Hover(2, true);
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('ook');
Mouse.Move(Inventory.Bounds());
RSNPCs.LumbridgeCook.Hover(2, False);
repeat
WriteLn 'This will only print after the mouse has finished moving because it's not asynchronous!';
until MainScreen.IsUpText('ook');
//Be in Lumbridge castle
RSW.WebWalk(WaspWeb.LOCATION_LUMBRIDGE);
RSNPCs.LumbridgeCook.Hover();
------------
Expand All @@ -860,33 +749,19 @@ TRSMMDot.WalkHover
~~~~~~~~~~~~~~~~~~
.. code-block:: pascal
function TRSMMDot.WalkHover(attempts: Int32 = 2; async: Boolean = True): Boolean;
function TRSMMDot.WalkHover(attempts: Int32 = 2; trackTarget: Boolean = TRACK_TARGET): Boolean;
Method used to walk and hover a TRSMMDot target if it's found on the mainscreen after walking.
It can hover synchronously and asynchronously.
Keep in mind the walking portion is not made asynchronously, only the final moments of the method
when it's time to hover the TRSMMDot target can be made asynchronously.

For NPCs that move, asynchronously is highly recommended.
It can update the target position as the mouse moves with **trackTarget**.
For NPCs that move, this is highly recommended.

Example
-------
.. code-block:: pascal
//Be in Lumbridge castle with a walker setup there.
rsw.WebWalk(WaspWeb.LOCATION_LUMBRIDGE);
RSNPCs.LumbridgeCook.WalkHover(2, true); //keep in mind that walking is not async.
repeat
WriteLn 'This will print while the mouse is moving because it's asynchronously!';
until MainScreen.IsUpText('ook');
rsw.WebWalk(WaspWeb.LOCATION_LUMBRIDGE);
RSNPCs.LumbridgeCook.WalkHover(2, False);
repeat
WriteLn 'This will only print after the mouse has finished moving because it's not asynchronous!';
until MainScreen.IsUpText('ook');
//Be in Lumbridge castle
RSW.WebWalk(WaspWeb.LOCATION_LUMBRIDGE);
RSNPCs.LumbridgeCook.WalkHover();
------------
Expand All @@ -898,9 +773,6 @@ TRSMMDot.Click
function TRSMMDot.Click(leftClick: Boolean = True; attempts: Int32 = 2): Boolean;
Method used to click a TRSMMDot target if it's found on the mainscreen.
This hovers the TRSMMDot target asynchronously.

For NPCs that move, asynchronously is highly recommended.

Example
-------
Expand All @@ -919,9 +791,6 @@ TRSMMDot.SelectOption
function TRSMMDot.SelectOption(action: TStringArray; attempts: Int32 = 2): Boolean;
Method used to select an option on a TRSMMDot target if it's found on the mainscreen.
This hovers the TRSMMDot target asynchronously.

For NPCs that move, asynchronously is highly recommended.

Example
-------
Expand All @@ -940,9 +809,6 @@ TRSMMDot.WalkClick
function TRSMMDot.WalkClick(leftClick: Boolean = True; attempts: Int32 = 2): Boolean;
Method used to walk and click a TRSMMDot target if it's found on the mainscreen.
This hovers the TRSMMDot target asynchronously.

For NPCs that move, asynchronously is highly recommended.

Example
-------
Expand All @@ -961,7 +827,6 @@ TRSMMDot.WalkSelectOption
function TRSMMDot.WalkSelectOption(action: TStringArray; attempts: Int32 = 2): Boolean;
Method used to walk and select an option on a TRSMMDot target if it's found on the mainscreen.
This hovers the TRSMMDot target asynchronously.

Example
-------
Expand Down
Loading

0 comments on commit 61b0865

Please sign in to comment.