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

Area

open class Area

Represents a contiguous set of tiles in the game

Constructors

Area

constructor()

Properties

center

open val center: WorldTile

Functions

contains

open fun contains(position: Positionable): Boolean

Checks if this area contains the specified position

containsMyPlayer

open fun containsMyPlayer(): Boolean

Checks if this area contains the local player

equals

open fun equals(o: Any): Boolean

fromPolygon

open fun fromPolygon(tiles: List<Tile>): Area

open fun fromPolygon(tiles: Array<Tile>): Area

Creates an Area from a polygon

fromRadius

open fun fromRadius(centerTile: Tile, radius: Int): Area

Creates an area around the center tile with the specified radius

fromRectangle

open fun fromRectangle(base1: Tile, base2: Tile): Area

Creates a rectangular area with the two specified tiles as the bounds

getAllTiles

open fun getAllTiles(): List<WorldTile>

Gets a list of all the tiles in the area.

getBounds

open fun getBounds(): Polygon

Gets the bounds of this area on the screen

getLegacyArea

open fun getLegacyArea(): RSArea

getMinimapBounds

open fun getMinimapBounds(): Polygon

Gets the bounds of this area on the minimap

getRandomTile

open fun getRandomTile(): WorldTile

Gets a random tile in this area

hashCode

open fun hashCode(): Int

toString

open fun toString(): String

translate

open fun translate(x: Int, y: Int): Area

Translates (shifts) this area by the specified x and y

open fun translate(x: Int, y: Int, z: Int): Area

Translates (shifts) this area by the specified x, y, and z