Gold Panning - guicampos/uo-scripts GitHub Wiki
DISCLAIMER: "Please no unattended crafting, fishing, panning, resource gathering or killing mobs afk for ANY reason. If you are caught afk macroing resources, you will lose all gains and gear, zero tolerance policy."
I DO NOT SUPPORT NOR ENCOURAGE AFK MACROING. ALWAYS FOLLOW THE SHARD RULES.
This is a system that makes it possible to greatly assist in marking the locations of large gold nuggets and the complete automation of the gold mining activity, just as other activities are easily macroed, such as fishing and mining. However, as already warned, I DO NOT SUPPORT NOR ENCOURAGE AFK MACROING.
This system is divided into 2 activities. The 'Search for new spot' activity and the 'panning Runebook Travel' activity, and they both need to be executed separated.
1st activity - Search for new spot
To be accurate, this system reads the coordinates of the spot with Large Gold Nugget being paned written on each item of a runebook. So, if you've have any panning runebook before, you'll need to remark all your spots using this 1st activity - Search for new spot before using the Runebook panning.
(example of a runebook used for this system. Every spot has a X, Y, Z, Graphic coordinate to guide the system to pan the exact location of a Large Nugget spot)
Prerequisites:
- You must have THIS pan storage (Graphic ID 0x09D7) with several Gold Pans stored inside it.
-
You must have a bank crystal inside your backpack.
-
You must have some loose recall runes inside your backpack
-
You must have a runebook (with empty spots) inside your backpack
-
You must have a treasure key inside your backpack.
-
You must have a dress agent called 'panning' in your dress agent. Set it up with fishing gear to have at least 200 fishing.
7. You must check and confirm every variable in the script, specially those at // YOU MUST CHANGE THOSE section.
Usage
The 1st activity - Search for new spot is done by manually calling the function panning_search_new_spot. You can create a shortcut button in your ingame screen by clicking on the 'Create fast call gump' button on the handling panel.
When all the prerequisites are checked and passing, all you have to do is stand at the closest point of a valid panning spot (check UOEvo documetation) and use the panning_search_new_spot button to start searching the near spots for large nuggets.
The first (and only) thing you should provide the script is targeting a valid runebook, with at least one rune spot left.
And wait and follow the messages on the screen.
You will notice that no other action is required. The script will handle every action needed to:
- Mark with fake graphics all valid water spots reachable by you
- Take a gold pan from out of the pan key
- Dress your panning clothes set
- Use the gold pan and target a valid pan spot
- wait for the panning complete
- empty and processes the pan results
- Cast the mark spell, etching the coordinates on the rune and storing the rune on the selected runebook.
The script will stop so you can move to another location if:
- A large nugget is found (because we're searching for larges, not panning all the nuggets)
- A medium nugget is found (becase when there is a medium will never have a large one)
- The spot is already marked on that book as a large spot
- There is nothing to pan anymore
Once the spot is fully searched, the script will automatically reorganize and store the findings and stop, so you can move to another spot to continue searching.
Once you have a runebook full of Large Nuggets spots, rename it **mandatorily **to 'Large Nuggets X', where X is the number of Large Nuggets books you have.
This is mandatory to the next activity.
(a full runebook with the coordinates annotated on the rune name)
reset or change the current working runebook
If you need to reset or change your current runebook being used to mark new spots, you can do:
tab 'Lists' > tab 'Objects', search and remove the LargeSpotBook object variable from the list.
Doing so makes the system ask you again for the runebook to be used.
API REFERENCE
Function call
panning_search_new_spot(waterTilesRange)
Description
This function searches for new pan spots in water tiles and marks them in a runebook. It is designed for use in Ultima Online (UO) scripting using the Orion UO client.
Parameters
waterTilesRange(number): The range (in tiles) for searching water tiles.
Returns
boolean: Returnstrueif successful, indicating that all spots have been analyzed and marked, orfalseotherwise.
Function Flow
- Initializes AFK check and world saves loop.
- Checks the availability of pan spots in the runebook.
- Validates the runebook.
- Closes the runebook gump.
- Removes duplicate water tiles within the specified range.
- Marks all water tiles on the map.
- Searches for large pan spots and marks them in the runebook.
- Skips medium pan spots (since they won't have large spots nearby).
- Performs additional actions after analyzing all spots:
- Trashes loot.
- Fills a gold key.
- Clears MiBs
- Prints a message indicating that all spots have been analyzed.
Exceptions
- Throws an error if the runebook gump is not found.
Example Usage
panning_search_new_spot(10); // Example usage with a waterTilesRange of 10
2nd activity - panning Runebook Travel
Now that you have walked a lot to find your spots with large nuggets, it's time to harvest them.
This activity uses the function panning_runebook_travel() to read runebook with the default name Large Nuggets # and recall (sacred journey actually) serially to the spot locations written marked in the book. Then it uses the written coordinates to pinpoint the large nugget spot.
Prerequisites
-
You must have THIS pan storage (Graphic ID 0x09D7) with several Gold Pans stored inside it.
-
You must have a bank crystal inside your backpack.
-
You must have at least one runebook with large spots found by the 1st activity.
-
You must have a treasure key inside your backpack.
-
You must setup a dress agent called 'panning' in your dress agent. Set it up with fishing gear to have at least 200 fishing.
-
You must have a recorded macro called 'gohome' that recalls to your house, or any safe place.
7. You must check and confirm every variable in the script, specially those at // YOU MUST CHANGE THOSE section.
Usage
The usage is fairly simple. Just stand on a safe place and call the panning_runebook_travel() function and watch the system working for you.
"Please no unattended crafting, fishing, panning, resource gathering or killing mobs afk for ANY reason. If you are caught afk macroing resources, you will lose all gains and gear, zero tolerance policy."
I DO NOT SUPPORT NOR ENCOURAGE AFK MACROING. ALWAYS FOLLOW THE SHARD RULES.
API REFERENCE
Function Call
panning_runebook_travel()
Description
This function automates the process of panning for large nuggets in Ultima Online (UO) using runebooks. It performs the following steps:
- Retrieves available runebooks.
- Filters out runebooks containing large nugget spots.
- Opens each valid runebook.
- Reads the positions of pan spots from the runebook.
- Recalls to each spot and pans for large nuggets.
- Performs cleanup actions after analyzing all spots.
- Returns home using a recall macro.
Usage
panning_runebook_travel();
Details
- Initializes AFK check and world saves loop.
- Retrieves all runebooks.
- Filters out runebooks containing large nugget spots.
- For each valid runebook:
- Opens the runebook.
- Reads the positions of pan spots.
- Recalls to each spot.
- Pans for large nuggets.
- After analyzing all spots:
- Trashes loot.
- Fills a gold key.
- Clears MiBs
- Prints a message indicating that all books have been panned.
- Returns home using a recall macro.
Exceptions
- Throws an error if no runebooks are available or if no valid panning books are found.
Multiple Books
This system was made with the intention of allowing several rune books to be run serially, that is, when the system finishes recalling the series of 16 spots from one book, another book is automatically loaded and processed in its entirety.
For this to be possible, simply have several books marked by the first activity (so that they have the X, Y, Z and graphic coordinates registered) and that all books have the pattern Large Nuggets #, where # is a numeric sequential number as their name. for each book you have.