net.runelite.api

Enum WorldType

java.lang.Object

java.lang.Enum<WorldType>

net.runelite.api.WorldType

All Implemented Interfaces:

Serializable, Comparable<WorldType>

public enum WorldType
extends Enum<WorldType>

An enumeration of possible world types.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOUNTY Bounty world type.
DEADMAN Deadman world type.
DEADMAN_TOURNAMENT Deadman Tournament world type.
LAST_MAN_STANDING Last man standing world type.
MEMBERS Members world type.
PVP Pvp world type.
PVP_HIGH_RISK Pvp high risk world type.
SEASONAL_DEADMAN Seasonal deadman world type.
SKILL_TOTAL Skill total world type.
TOURNAMENT Tournament world type.

Method Summary

Modifier and Type	Method and Description
static EnumSet<WorldType>	fromMask(int mask) Create enum set of world types from mask.
static boolean	isPvpWorld(Collection<WorldType> worldTypes) Checks whether a world having a Collection of WorldTypes is a PVP world.
static int	toMask(EnumSet<WorldType> types) Create mask from enum set of world types.
static WorldType	valueOf(String name) Returns the enum constant of this type with the specified name.
static WorldType[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

MEMBERS

public static final WorldType MEMBERS

Members world type.

PVP

public static final WorldType PVP

Pvp world type.

BOUNTY

public static final WorldType BOUNTY

Bounty world type.

SKILL_TOTAL

public static final WorldType SKILL_TOTAL

Skill total world type.

PVP_HIGH_RISK

public static final WorldType PVP_HIGH_RISK

Pvp high risk world type.

LAST_MAN_STANDING

public static final WorldType LAST_MAN_STANDING

Last man standing world type.

TOURNAMENT

public static final WorldType TOURNAMENT

Tournament world type.

DEADMAN_TOURNAMENT

public static final WorldType DEADMAN_TOURNAMENT

Deadman Tournament world type.

DEADMAN

public static final WorldType DEADMAN

Deadman world type.

SEASONAL_DEADMAN

public static final WorldType SEASONAL_DEADMAN

Seasonal deadman world type.

Method Detail

values

public static WorldType[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (WorldType c : WorldType.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static WorldType valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

fromMask

public static EnumSet<WorldType> fromMask(int mask)

Create enum set of world types from mask.

Parameters:

mask - the mask

Returns:

the enum set

toMask

public static int toMask(EnumSet<WorldType> types)

Create mask from enum set of world types.

Parameters:

types - the types

Returns:

the int containing all mask

isPvpWorld

public static boolean isPvpWorld(Collection<WorldType> worldTypes)

Checks whether a world having a Collection of WorldTypes is a PVP world.

Parameters:

worldTypes - A Collection of WorldTypes describing the given world.

Returns:

True if the given worldtypes of the world are a PVP world, false otherwise.

See Also:

Client.getWorldType()