Jump to content
Search In
  • More options...
Find results that contain...
Find results in...
Encoded

Task Framework Tutorial

Recommended Posts

Posted (edited)

Task Framework

A set is a collection that contains no duplicate elements.
The task framework is a sorted set of tasks where each task performs a specific action.
Tasks are sorted in descending order by priority.

Each task has a validate and execute method. The validate method returns a boolean that decides whether or not the task should execute. The execute method should be called when the validate method returns true.

Priority determines which task will be returned by the getValidTask method if two or more tasks' validate methods are to return true.
If you find yourself having two tasks' validate methods returning true with the same priority level, add additional priority levels or modify the tasks' validate methods.

TaskSet is the aggregate of all the tasks. Tasks are sorted upon being added to the set. The getValidTask method returns the highest priority task with a validate method that returns true or null if no task is valid.

Don't forgot to change the packaging if you are copy/pasting the following code.

Task.java
package scripts.api.script.frameworks.task;

public interface Task {

    Priority priority();

    boolean validate();

    void execute();

}
Priority.java
package scripts.api.script.frameworks.task;

public enum Priority {

    HIGH,
    MEDIUM,
    LOW,
    NONE

}
TaskSet.java
package scripts.api.script.frameworks.task;

import java.util.Arrays;
import java.util.Collection;
import java.util.Comparator;
import java.util.List;
import java.util.TreeSet;

public class TaskSet extends TreeSet<Task> {

    public TaskSet() {
        super(Comparator.comparing(Task::priority).thenComparing(Comparator.comparing(task -> task.getClass().getName())));
    }

    public TaskSet(Task... tasks) {
        super(Comparator.comparing(Task::priority).thenComparing(Comparator.comparing(task -> task.getClass().getName())));
        addAll(tasks);
    }

    public TaskSet(Comparator<? super Task> comparator) {
        this();
    }

    public TaskSet(Collection<? extends Task> c) {
        this(c.toArray(new Task[c.size()]));
    }

    public TaskSet(SortedSet<Task> s) {
        this(s.toArray(new Task[s.size()]));
    }

    public boolean addAll(Task... tasks) {
        return super.addAll(Arrays.asList(tasks));
    }

    public Task getValidTask() {
        for (Task task : this) {
            if (task.validate()) {
                return task;
            }
        }
        return null;
    }

}
Example Task
public class ExampleTask implements Task {

    @Override
    public String toString() {
        return "Example Task";
    }

    @Override
    public Priority priority() {
        return Priority.LOW;
    }

    @Override
    public boolean validate() {
        return false;
    }

    @Override
    public void execute() {

    }
    
}
Example Script run Method
@Override
public void run() {
    TaskSet tasks = new TaskSet(new ExampleTask());
    while (isRunning) {
        Task task = tasks.getValidTask();
        if (task != null) {
            status = task.toString();
            task.execute();
        }
    }
}
Edited by Encoded
  • Like 1
  • Thanks 1

Share this post


Link to post
Share on other sites

@Encoded So can you tell me how much stuff you should include in each task? Because it seems counter-intuitive to do a new task for every small action if your script is big.

So for example if I want my script to wc and bank before doing another task that could be a quest or other skill. 

I can include my whole wcing/banking code in a single task?

Or should I spread my wcing into various tasks. (one for walking, one for cutting, one for banking)

 

Share this post


Link to post
Share on other sites
5 hours ago, Enano25 said:

@Encoded So can you tell me how much stuff you should include in each task? Because it seems counter-intuitive to do a new task for every small action if your script is big.

So for example if I want my script to wc and bank before doing another task that could be a quest or other skill. 

I can include my whole wcing/banking code in a single task?

Or should I spread my wcing into various tasks. (one for walking, one for cutting, one for banking)

 

I would separate walking, banking, and wcing into 3 tasks. They each need to be done when different conditions are met, and should be assigned different priorities based on the conditions met.

 

Share this post


Link to post
Share on other sites
Posted (edited)
8 hours ago, Azuz53487 said:

Wasn't this posted somewhere? Can't remember where I saw it.

I had it in the snippets section, but I rewrote it and moved it to tutorials since that's where the other frameworks are posted.

 

7 hours ago, Enano25 said:

@Encoded So can you tell me how much stuff you should include in each task? Because it seems counter-intuitive to do a new task for every small action if your script is big.

So for example if I want my script to wc and bank before doing another task that could be a quest or other skill. 

I can include my whole wcing/banking code in a single task?

Or should I spread my wcing into various tasks. (one for walking, one for cutting, one for banking)

You can break it down as much as you want. I've even made scripts where a Task will have its own TaskSet within it.
If you want to chain TaskSets together, I suggest adding a stopping condition and then creating a linked list of TaskSets so that you can get the next TaskSet once the current's stopping condition is met. That's what I currently do, but this post is about the basics so I didn't include that.

Edited by Encoded
  • Like 1

Share this post


Link to post
Share on other sites
3 hours ago, Encoded said:

I had it in the snippets section, but I rewrote it and moved it to tutorials since that's where the other frameworks are posted.

 

You can break it down as much as you want. I've even made scripts where a Task will have its own TaskSet within it.
If you want to chain TaskSets together, I suggest adding a stopping condition and then creating a linked list of TaskSets so that you can get the next TaskSet once the current's stopping condition is met. That's what I currently do, but this post is about the basics so I didn't include that.

Aha, I see! Great! :)

Share this post


Link to post
Share on other sites

Create an account or sign in to comment

You need to be a member in order to leave a comment

Create an account

Sign up for a new account in our community. It's easy!

Register a new account

Sign in

Already have an account? Sign in here.

Sign In Now

  • Our picks

    • This release will:

      Fix LG for both OSBuddy and RuneLite


      Fix issue where the resizable client isn't able to be made smaller (Thanks @JoeDezzy1)


      Fix detection of the logout game tab when resizable mode and side panels are enabled (Thanks @JoeDezzy1)


      Add initial support for Sentry to allow us to identify and easily debug exceptions happening with all TRiBot users


      Add methods to determine if the bank is actually loaded, and not just the overarching interface (Thanks @wastedbro)



      Upcoming updates:

      Improved CLI support


      Full Sentry support


      Much more
        • Like
      • 46 replies
    • This release will:

      Fix NPE in Camera API (Thanks @wastedbro)


      Update deposit box interface ids (Thanks @Encoded)


      Add various bank methods (Thanks @wastedbro)


      Banking#getWithdrawXQuantity


      Banking#getDefaultWithdrawQuantity


      Banking#arePlaceholdersOn




      Fix resizeable minimap bug (Thanks @wastedbro)


      Remove Java 8 requirement


      Please note: TRiBot is not yet fully compatible with Java 10+




      Fix the break handler issues by ensuring the break handler thread never gets paused


      Fix broken settings hooks



      Upcoming updates:

      Improved CLI support


      Much more



      Note: If you are using LG, please restart both the RS client and TRiBot
        • Like
      • 68 replies
    • This release will:

      Add support for using custom F key bindings to switch between game tabs (Thanks @erickho123)


      Fix tab opening for "Skills" and "Kourend Tasks" (Thanks @erickho123)



      Note: If you are using LG, please restart both the RS client and TRiBot
        • Like
      • 34 replies
    • This release will:

      Fix an issue where breaks would stop firing


      Fix Combat#getWildernessLevel, use dynamic search for text and cache ID for later calls


      Fix an NPE in the Combat API


      Fix Mouse#leaveGame bug where the mouse wouldn't actually leave the game screen
        • Like
      • 21 replies
    • This release will:

      Add LG support for Runelite


      Fix NPCChat issues


      Fix a bug where the camera angle setter would just hold down a key for 5 seconds (the timeout)


      Slightly adjust the rotation via keys to be more accurate


      Add the ability for asynchronous camera movement via keys


      Make Camera rotation via mouse more fluid, with more antiban, and work much better in resizable mode


      Add a "Camera#setCamera" method, allowing the rotation and angle to be set in parallel


      Increase the likelihood of using the mouse for camera movements


      Add support for adjusting the camera to positionable entities (Positionable#adjustCameraTo)



      Upcoming updates:

      Improved CLI support


      Much more



      Note: If you are using LG, please restart both the RS client and TRiBot
        • Thanks
        • Like
      • 59 replies
  • Recently Browsing   0 members

    No registered users viewing this page.

×