Question about Rs2Walker.handleTransports

[Krulvis]

There is some magic going on inside Rs2Walker.handleTransports that I need help with understanding.

This function is called every step in the path in Rs2Walker.processWalk so see if there's a transport that the web should take here:

boolean inInstance = Microbot.getClient().getTopLevelWorldView().isInstance();
if (PohTeleports.isInHouse() || !inInstance) {
    doorOrTransportResult = handleTransports(path, i);
}

The handleTransports function starts with obtaining all the Transports that are stored for the current tile:
Set<Transport> transports = ShortestPathPlugin.getTransports().getOrDefault(path.get(indexOfStartPoint), new HashSet<>());
Take note: this also includes teleports (with origin null) on the first step in the path as teleports are always added to the starting tile of the path.

Then, the handleTransports function loops over all Transports that it received for the current step path.get(indexOfStartPoint) which is actually i and increases every loop of processWalk.

Set<Transport> transports = ShortestPathPlugin.getTransports().getOrDefault(path.get(indexOfStartPoint), new HashSet<>());
        log.debug("Found transports: {}", transports.stream().map(Transport::getDisplayInfo).collect(Collectors.joining(", ")));
        for (Transport transport : transports) {
            Collection<WorldPoint> worldPointCollections;
            //in some cases the getOrigin is null, for teleports that start the player location
            if (transport.getOrigin() == null) {
                worldPointCollections = Collections.singleton(null);
            } else {
                worldPointCollections = WorldPoint.toLocalInstance(Microbot.getClient().getTopLevelWorldView(), transport.getOrigin());
            }
            log.debug("Considering transport: {}", transport.getDisplayInfo());
            for (WorldPoint origin : worldPointCollections) {
                if (transport.getOrigin() != null && Rs2Player.getWorldLocation().getPlane() != transport.getOrigin().getPlane()) {
                    continue;
                }

                for (int i = indexOfStartPoint; i < path.size(); i++) {
                    if (origin != null && origin.getPlane() != Rs2Player.getWorldLocation().getPlane())
                        continue;

//
// Little bit down the line once we decide to make use of a transport
                   if (transport.getType() == TransportType.POH) {
                        if (handlePohTransport(transport)) {
                            sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(transport.getDestination()) < OFFSET, 10000);
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.CANOE) {
                        if (handleCanoe(transport)) {
                            sleep(600 * 2); // wait 2 extra ticks before walking
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.SPIRIT_TREE) {
                        if (handleSpiritTree(transport)) {
                            sleepUntil(() -> !Rs2Player.isAnimating());
                            sleepUntilTrue(() -> Rs2Player.getWorldLocation().distanceTo(transport.getDestination()) < 10);
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.QUETZAL) {
                        if (handleQuetzal(transport)) {
                            sleep(600 * 2); // wait 2 extra ticks before walking
                            break;
                        }
                    }

Now, I understand that we need to work through a list of Transports because in the walker we don't have access to the actual path of Nodes and Transports that were generated by the Pathfinder. To determine which Transport out of the list for this WorldPoint the Pathfinder meant to make use of, handleTransports loops through the received Transports. By doing checks like: if (path.stream().noneMatch(x -> x.equals(transport.getDestination()))) continue; we can pin down the Transport that the path meant to take.

So far so good... Now the thing that I don't understand is: why don't we exit the function after handling a transport that passed all the filters and thus we determined we should take for this step in the path? Instead of exiting the function, it breaks the for (WorldPoint origin : worldPointCollections) { and continues looping further through all the other transports available this step and might chain multiple transports for the original step in the path after each other.

Is this behavior intentional and are there scenario's that I cannot think of that requires this behavior? Or was this just never a problem until PoH was introduced?

[chsami]

There is some magic going on inside Rs2Walker.handleTransports that I need help with understanding.

This function is called every step in the path in Rs2Walker.processWalk so see if there's a transport that the web should take here:

boolean inInstance = Microbot.getClient().getTopLevelWorldView().isInstance();
if (PohTeleports.isInHouse() || !inInstance) {
    doorOrTransportResult = handleTransports(path, i);
}

The handleTransports function starts with obtaining all the Transports that are stored for the current tile: Set<Transport> transports = ShortestPathPlugin.getTransports().getOrDefault(path.get(indexOfStartPoint), new HashSet<>()); Take note: this also includes teleports (with origin null) on the first step in the path as teleports are always added to the starting tile of the path.

Then, the handleTransports function loops over all Transports that it received for the current step path.get(indexOfStartPoint) which is actually i and increases every loop of processWalk.

Set<Transport> transports = ShortestPathPlugin.getTransports().getOrDefault(path.get(indexOfStartPoint), new HashSet<>());
        log.debug("Found transports: {}", transports.stream().map(Transport::getDisplayInfo).collect(Collectors.joining(", ")));
        for (Transport transport : transports) {
            Collection<WorldPoint> worldPointCollections;
            //in some cases the getOrigin is null, for teleports that start the player location
            if (transport.getOrigin() == null) {
                worldPointCollections = Collections.singleton(null);
            } else {
                worldPointCollections = WorldPoint.toLocalInstance(Microbot.getClient().getTopLevelWorldView(), transport.getOrigin());
            }
            log.debug("Considering transport: {}", transport.getDisplayInfo());
            for (WorldPoint origin : worldPointCollections) {
                if (transport.getOrigin() != null && Rs2Player.getWorldLocation().getPlane() != transport.getOrigin().getPlane()) {
                    continue;
                }

                for (int i = indexOfStartPoint; i < path.size(); i++) {
                    if (origin != null && origin.getPlane() != Rs2Player.getWorldLocation().getPlane())
                        continue;

//
// Little bit down the line once we decide to make use of a transport
                   if (transport.getType() == TransportType.POH) {
                        if (handlePohTransport(transport)) {
                            sleepUntil(() -> Rs2Player.getWorldLocation().distanceTo(transport.getDestination()) < OFFSET, 10000);
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.CANOE) {
                        if (handleCanoe(transport)) {
                            sleep(600 * 2); // wait 2 extra ticks before walking
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.SPIRIT_TREE) {
                        if (handleSpiritTree(transport)) {
                            sleepUntil(() -> !Rs2Player.isAnimating());
                            sleepUntilTrue(() -> Rs2Player.getWorldLocation().distanceTo(transport.getDestination()) < 10);
                            break;
                        }
                    }

                    if (transport.getType() == TransportType.QUETZAL) {
                        if (handleQuetzal(transport)) {
                            sleep(600 * 2); // wait 2 extra ticks before walking
                            break;
                        }
                    }

Now, I understand that we need to work through a list of Transports because in the walker we don't have access to the actual path of Nodes and Transports that were generated by the Pathfinder. To determine which Transport out of the list for this WorldPoint the Pathfinder meant to make use of, handleTransports loops through the received Transports. By doing checks like: if (path.stream().noneMatch(x -> x.equals(transport.getDestination()))) continue; we can pin down the Transport that the path meant to take.

So far so good... Now the thing that I don't understand is: why don't we exit the function after handling a transport that passed all the filters and thus we determined we should take for this step in the path? Instead of exiting the function, it breaks the for (WorldPoint origin : worldPointCollections) { and continues looping further through all the other transports available this step and might chain multiple transports for the original step in the path after each other.

Is this behavior intentional and are there scenario's that I cannot think of that requires this behavior? Or was this just never a problem until PoH was introduced?

I can't think of a scenario that would require multiple transports to be chained, since the walker will come back in it after it has used the transport in the next loop to continue walking I think it makes sense to exit the function. But needs to be tested.