Package 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 Description BETA_WORLD
Beta world.BOUNTY
Bounty world type.DEADMAN
Deadman world type.EOC_ONLY
FRESH_START_WORLD
Fresh start world typeHIGH_RISK
High risk world type.LAST_MAN_STANDING
Last man standing world type.LEGACY_ONLY
MEMBERS
Members world type.NOSAVE_MODE
Beta worlds without profiles that are saved.PVP
Pvp world type.PVP_ARENA
PVP arena world type.QUEST_SPEEDRUNNING
Quest speedrunningSEASONAL
Seasonal world type for leagues and seasonal deadman.SKILL_TOTAL
Skill total world type.TOURNAMENT_WORLD
Tournament world type
-
Method Summary
All Methods Static Methods Concrete Methods Modifier and Type Method 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 aCollection
ofWorldType
s 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.
-
-
-
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.
-
PVP_ARENA
public static final WorldType PVP_ARENA
PVP arena world type.
-
SKILL_TOTAL
public static final WorldType SKILL_TOTAL
Skill total world type.
-
QUEST_SPEEDRUNNING
public static final WorldType QUEST_SPEEDRUNNING
Quest speedrunning
-
HIGH_RISK
public static final WorldType HIGH_RISK
High risk world type.
-
LAST_MAN_STANDING
public static final WorldType LAST_MAN_STANDING
Last man standing world type.
-
BETA_WORLD
public static final WorldType BETA_WORLD
Beta world.
-
LEGACY_ONLY
public static final WorldType LEGACY_ONLY
-
EOC_ONLY
public static final WorldType EOC_ONLY
-
NOSAVE_MODE
public static final WorldType NOSAVE_MODE
Beta worlds without profiles that are saved.
-
TOURNAMENT_WORLD
public static final WorldType TOURNAMENT_WORLD
Tournament world type
-
FRESH_START_WORLD
public static final WorldType FRESH_START_WORLD
Fresh start world type
-
DEADMAN
public static final WorldType DEADMAN
Deadman world type.
-
SEASONAL
public static final WorldType SEASONAL
Seasonal world type for leagues and seasonal deadman.
-
-
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 nameNullPointerException
- 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 aCollection
ofWorldType
s is a PVP world.- Parameters:
worldTypes
- ACollection
ofWorldType
s describing the given world.- Returns:
- True if the given worldtypes of the world are a PVP world, false otherwise.
- See Also:
Client.getWorldType()
-
-