Interface ExportedGuide

@Experimental @NonExtendable public interface ExportedGuide
Access to the guide data that was previously exported from the game.

  • Method Details

    • getDefaultNamespace

      String getDefaultNamespace()

    • resolveId

      String resolveId(String id)
      Resolves a potentially namespace-less id to an id that is guaranteed to have a namespace by using the default namespace of the guide.

    • tryGetItemInfo

      @Nullable ExportedItemInfo tryGetItemInfo(String itemId)

    • getItemInfo

      ExportedItemInfo getItemInfo(String itemId)
      Throws:
      IllegalArgumentException - If the item was not exported.

    • tryGetFluidInfo

      @Nullable ExportedFluidInfo tryGetFluidInfo(String fluidId)

    • getFluidInfo

      ExportedFluidInfo getFluidInfo(String fluidId)
      Throws:
      IllegalArgumentException - If the fluid was not exported.

    • getRecipeById

      @Nullable ExportedRecipe getRecipeById(String recipeId)

    • getRecipesForItem

      List<? extends ExportedRecipe> getRecipesForItem(String itemId)
      Returns all recipes that produce the given item.
      Returns:
      all recipes that produce the given item

    • pageExists

      boolean pageExists(String pageId)

    • getPageIdForItem

      @Nullable String getPageIdForItem(String itemId)
      Returns the id of the page that is the primary page for the given item, or null if no such page exists.
      Returns:
      the id of the page that is the primary page for the given item, or null if no such page exists

    • getExtraData

      @Nullable Object getExtraData(String identifier)
      Returns mod specific data that was exported alongside the guide.
      Returns:
      mod specific data that was exported alongside the guide
      See Also: