Method Detail

• getCurrentWorld

  public static int getCurrentWorld()

• all

  public static java.util.List<World> all()

  Gets a List of all the worlds

  Returns:

  List of all worlds

• refresh

  public static void refresh()

• clearWorlds

  public static void clearWorlds()

  Clears the world list and sets it to null

• all

  public static java.util.List<World> all​(Filter<World> filter)

  Returns a List of all worlds that match the given Filter

  Parameters:

  filter - Filter for worlds

  Returns:

  List of worlds that match the given Filter

• f2p

  public static java.util.List<World> f2p()

  Returns a list of f2p Worlds

  Returns:

  List of f2p Worlds

• members

  public static java.util.List<World> members()

  returns a List of members only worlds

  Returns:

  List of members only worlds

• pvp

  public static java.util.List<World> pvp()

  Gets a list of pvp worlds

  Returns:

  List of pvp worlds

• highRisk

  public static java.util.List<World> highRisk()

  Gets a list of high risk worlds

  Returns:

  List of high risk worlds

• noMinimumLevel

  public static java.util.List<World> noMinimumLevel()

  Gets a list of worlds with no required level

  Returns:

  List of worlds with no required level

• getWorld

  public static World getWorld​(int world)

  Gets a World object according to the given world number

  Parameters:

  world - world ID, can be in 301 format or 1

  Returns:

  World matching the given ID or null if none found

• getWorld

  public static World getWorld​(Filter<World> filter)

  Gets the first World that matches the filter

  Parameters:

  filter - Filter for the World

  Returns:

  First World that matches the Filter or null if none found

• getRandomWorld

  public static World getRandomWorld()

  Gets a random world from all the worlds

  Returns:

  Random world from all the worlds

• getRandomWorld

  public static World getRandomWorld​(java.util.List<World> worlds)

  Gets a random World from a given List

  Parameters:

  worlds - List of worlds to choose from

  Returns:

  random World or null if list is empty or null

• getRandomWorld

  public static World getRandomWorld​(Filter<World> worldFilter)

  Gets a random World that matches the given Filter

  Parameters:

  worldFilter - Filter for Worlds

  Returns:

  Random World or null if no matches on filter

• getNormalizedWorlds

  public static java.util.List<World> getNormalizedWorlds()

  Gets a list of normalized Worlds Normalized meaning not: pvp, deadmode, tournament, twisted leauge, last man standing, bounty hunter, or high risk.

  Returns:

  List of normalized worlds.

• getMyWorld

  @Deprecated
  public static World getMyWorld()

  Deprecated.

  see getCurrent()

• getCurrent

  public static World getCurrent()

  Gets your current world

  Returns:

  Your current world

• updatePing

  public static void updatePing​(World w)

• getExactLocation

  public static Location getExactLocation​(World w)

  Uses the world hopper widgets in game to determine real location of a given world.

  Parameters:

  w - World to get the real location of

  Returns:

  Location representing the more precise location where available. Returns World.getLocation() as a default/fallback