script-sdk/org.tribot.script.sdk.types/World

World

open class World

Represents a world in the list of worlds available

Constructors

World

constructor(server: RSServer)

Types

Location

enum Location

Represents the location that a world can have.

Type

enum Type

Represents the types that a world can have.

Functions

equals

open fun equals(o: Any): Boolean

getActivity

open fun getActivity(): Optional<String>

Gets the name of the activity of this world

getHostAddress

open fun getHostAddress(): String

Gets the host domain address (ex.

getLocation

open fun getLocation(): World.Location

Gets the world Location

getPing

open fun getPing(): Optional<Integer>

Attempts to calculate the ping for this world.

getPlayerCount

open fun getPlayerCount(): Int

Gets the number of players listed in this world

getTotalLevelRequirement

open fun getTotalLevelRequirement(): Int

Gets the total level requirement for this world

getTypes

open fun getTypes(): Set<World.Type>

Gets all the types of this world.

getWorldNumber

open fun getWorldNumber(): Int

Gets the number of this world, ex.

hashCode

open fun hashCode(): Int

isDangerous

open fun isDangerous(): Boolean

Checks if this world has some alternative combat rules or form of items lost on death.

isLowPing

open fun isLowPing(): Boolean

Checks if this world has low ping relative to other worlds.

isMainGame

open fun isMainGame(): Boolean

Checks if this world is a part of the 'main' game, not some secondary game mode

isMembers

open fun isMembers(): Boolean

Checks if this world is a members world

isRequirementsMet

open fun isRequirementsMet(): Boolean

Checks if this world can be entered, the best it can with the information available.

isType

open fun isType(types: Array<World.Type>): Boolean

Checks if this world matches all the specified types

isTypesAny

open fun isTypesAny(types: Array<World.Type>): Boolean

Checks if this world matches any of the specified types

isTypesExactly

open fun isTypesExactly(types: Array<World.Type>): Boolean

Checks if this world matches the specified types exactly.

toString

open fun toString(): String

World

See also

Constructors

Types

Functions