Get Island Type

Version Note

This tutorial was originally created for an earlier version of Brobot but has been updated for version 1.1.0. The original code examples are available in documentation versions 1.0.6 and 1.0.7.

Here we determine the island type from the on-screen text.

Go to a new Island and Get its Type

Here we call the transition directly instead of using Brobot's state navigation system. In Brobot 1.1.0, navigation between states is handled by StateNavigator (which provides the openState() methods), while StateTransitions manages the actual transition execution. Normally we would use the state navigation system through StateNavigator.openState(), which takes care of everything related to transitions, including finding and traversing paths. In this case, the state navigation system would not do anything because the Island state is already active. In this special situation, we want to perform the transition activities from the World state to the Island state even though the Island state is already present. The reason we want to do this is that this transition will take us to a different island. The Island state does not know whether the specific island has changed. It only recognizes that it is on an island.

If the text we found on-screen contains any of these substrings, we return the corresponding island type. Otherwise, we return an empty string.

public String getIsland() {
    worldTransitions.goToIsland();
    String textRead = getIslandType();
    for (Map.Entry<String, String> type : islandTypes.entrySet()) {
        if (textRead.contains(type.getKey())) return type.getValue();
    }
    return "";
}

Capturing Text

With the following action we retrieve the text found where the island names are. We know that at least one name was already found when the state management system opened the Island state, since the IslandName variable is the only StateImage that identifies the Island state. Since the IslandName has already been found once, its SearchRegion will be defined as the region where it was first found. We can then use this SearchRegion to retrieve the name of the new island type.

Text extraction is automatically included in Find operations as of version 1.0.7. We use the ALL_WORDS find strategy to extract all text from the defined region.

private String getIslandType() {
    // Using modern TextFindOptions with fluent API
    TextFindOptions findText = new TextFindOptions.Builder()
            .setFindWords(TextFindOptions.FindWords.ALL)
            .setSearchRegions(island.getIslandName().getSearchRegion())
            .setPauseBeforeBegin(3.0)
            .build();
    
    Matches matches = action.perform(findText, island.getIslandName());
    // Combine all found words into a single string
    return matches.getMatchList().stream()
            .map(Match::getText)
            .collect(Collectors.joining(" "));
}

Converting Text to Island Types

First, we create a variable that maps pieces of the island type words that are representative of these words. For example, "Mine" is representative of the type Mines; if our text retrieval function finds the word "Minez", we can assume that the real text is "Mines", since the string "Mine" is part of "Minez".

private Map<String, String> islandTypes = new HashMap<>();

// Initialize the map
{
    islandTypes.put("Burg", "Castle");
    islandTypes.put("Mine", "Mines");
    islandTypes.put("Farm", "Farms");
    islandTypes.put("Moun", "Mountains");
    islandTypes.put("Fore", "Forest");
    islandTypes.put("Lake", "Lakes");
}