World

open class World

Represents a world in the list of worlds available

See also

Constructors

Link copied to clipboard
constructor(server: RSServer)

Types

Link copied to clipboard
Represents the location that a world can have.
Link copied to clipboard
enum Type
Represents the types that a world can have.

Functions

Link copied to clipboard
open fun equals(o: Any): Boolean
Link copied to clipboard
Gets the name of the activity of this world
Link copied to clipboard
Gets the host domain address (ex.
Link copied to clipboard
Gets the world Location
Link copied to clipboard
open fun getPing(): Optional<Integer>
Attempts to calculate the ping for this world.
Link copied to clipboard
open fun getPlayerCount(): Int
Gets the number of players listed in this world
Link copied to clipboard
Gets the total level requirement for this world
Link copied to clipboard
open fun getTypes(): Set<World.Type>
Gets all the types of this world.
Link copied to clipboard
open fun getWorldNumber(): Int
Gets the number of this world, ex.
Link copied to clipboard
open fun hashCode(): Int
Link copied to clipboard
open fun isDangerous(): Boolean
Checks if this world has some alternative combat rules or form of items lost on death.
Link copied to clipboard
open fun isLowPing(): Boolean
Checks if this world has low ping relative to other worlds.
Link copied to clipboard
open fun isMainGame(): Boolean
Checks if this world is a part of the 'main' game, not some secondary game mode
Link copied to clipboard
open fun isMembers(): Boolean
Checks if this world is a members world
Link copied to clipboard
Checks if this world can be entered, the best it can with the information available.
Link copied to clipboard
open fun isType(types: Array<World.Type>): Boolean
Checks if this world matches all the specified types
Link copied to clipboard
open fun isTypesAny(types: Array<World.Type>): Boolean
Checks if this world matches any of the specified types
Link copied to clipboard
Checks if this world matches the specified types exactly.
Link copied to clipboard
open fun toString(): String