org.osbot.rs07.api

Class Map

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Map

public class Map
extends API

Represents the API regarding map functionality.

Field Summary

Fields

Modifier and Type	Field and Description
static int	LOCAL_COORD_BITS

Fields inherited from class org.osbot.rs07.script.MethodProvider

bank, bot, camera, chatbox, client, colorPicker, combat, configs, depositBox, dialogues, diaries, display, doorHandler, equipment, experienceTracker, favour, grandExchange, graphicObjects, groundItems, hintArrow, inventory, keyboard, logger, logoutTab, magic, map, menu, mouse, npcs, objects, players, prayer, projectiles, quests, settings, skills, store, tabs, trade, walking, widgets, worlds

Constructor Summary

Constructors

Constructor and Description
Map()

Method Summary

Modifier and Type	Method and Description
boolean	canReach(Entity entity) Determines whether the specified entity can be reached from your current position.
boolean	canReach(Position position) Determines whether the specified position can be reached from your current position.
boolean	contains(Entity entity) Returns whether the specified entity exists in the loaded region.
int	distance(Entity entity) The absolute distance between your player's position and the specified position.
int	distance(Position position) The absolute distance between your player's position and the specified position.
int	getBaseX() Gets the absolute X coordinate of your map region.
int	getBaseY() Gets the absolute Y coordinate of your map region.
int[][]	getClippingFlags() Gets the clipping flags
Position	getDestination() Gets your walking destination.
int	getPlane() Gets your current plane or 'z'.
Region	getRegion() Gets the currently loaded region
int	getWildernessLevel() Retrieves your current wilderness level.
void	initializeModule()
boolean	isInHouse() Determines whether you are in your player owned house or not.
boolean	isMinimapLocked() Returns if the minimap has been locked/blacked out.
boolean	isMultiway() Checks if you are in multiway combat.
boolean	isWithinRange(Entity entity, int threshold) Determines whether your character is within the specified range of an entity.
boolean	isWithinRange(Position position, Entity entity, int threshold) Determines whether the specified position is within the specified range of an entity.
int	realDistance(Entity entity) Determines the shortest real distance to the specified entity as if you would be walking towards it.
int	realDistance(Position position) Determines the shortest real distance to the specified position as if you would be walking towards it.
int	realDistance(Position from, Position to) Determines the shortest real distance between the specified positions

Methods inherited from class org.osbot.rs07.script.MethodProvider

exchangeContext, execute, getBank, getBot, getCamera, getChatbox, getClient, getColorPicker, getCombat, getConfigs, getDepositBox, getDialogues, getDiaries, getDisplay, getDoorHandler, getEquipment, getExperienceTracker, getFavour, getGrandExchange, getGraphicObjects, getGroundItems, getHintArrow, getInventory, getKeyboard, getLogoutTab, getMagic, getMap, getMenuAPI, getMouse, getNpcs, getObjects, getPlayers, getPrayer, getProjectiles, getQuests, getSettings, getSkills, getStore, getTabs, getTrade, getWalking, getWidgets, getWorlds, gRandom, gRandom, gRandom, initializeContext, log, log, myPlayer, myPosition, random, random, sleep, stripFormatting, warn

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOCAL_COORD_BITS

public static final int LOCAL_COORD_BITS

See Also:

Constant Field Values

Constructor Detail

Map

public Map()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

getRegion

public Region getRegion()

Gets the currently loaded region

Returns:

The currently loaded region

getClippingFlags

public int[][] getClippingFlags()

Gets the clipping flags

Returns:

the clipping flags

distance

public int distance(Position position)

The absolute distance between your player's position and the specified position.

Parameters:

position - The position to calculate for.

Returns:

The absolute distance.

distance

public int distance(Entity entity)

The absolute distance between your player's position and the specified position.

Parameters:

entity - The position to calculate for.

Returns:

The absolute distance.

canReach

public boolean canReach(Position position)

Determines whether the specified position can be reached from your current position.

Parameters:

position - The position to reach.

Returns:

True if the specified position can be reached from your current position.

canReach

public boolean canReach(Entity entity)

Determines whether the specified entity can be reached from your current position.

Parameters:

entity - The entity to reach.

Returns:

True if the specified entity can be reached from your current position.

realDistance

public int realDistance(Position position)

Determines the shortest real distance to the specified position as if you would be walking towards it.

Parameters:

position - The position to calculate the distance to.

Returns:

The shortest real distance to the specified position.

realDistance

public int realDistance(Position from,
                        Position to)

Determines the shortest real distance between the specified positions

Parameters:

from - The position to calculate the distance from.

to - The position to calculate the distance to.

Returns:

The shortest real distance between the specified positions.

realDistance

public int realDistance(Entity entity)

Determines the shortest real distance to the specified entity as if you would be walking towards it.

Parameters:

entity - The entity to calculate the distance to.

Returns:

The shortest real distance to the specified position.

contains

public boolean contains(Entity entity)

Returns whether the specified entity exists in the loaded region.

Parameters:

entity - The entity to check its existence for.

Returns:

True if the entity exists.

getBaseX

public int getBaseX()

Gets the absolute X coordinate of your map region.

Returns:

The absolute X coordinate of your map region.

getBaseY

public int getBaseY()

Gets the absolute Y coordinate of your map region.

Returns:

The absolute Y coordinate of your map region.

getPlane

public int getPlane()

Gets your current plane or 'z'.

Also known as height.

Returns:

The current plane.

getDestination

public Position getDestination()

Gets your walking destination.

This is the the flag on the minimap.

Returns:

The position of the destination you are walking to.

isInHouse

public boolean isInHouse()

Determines whether you are in your player owned house or not. WITHDRAW_NOTE: this method only works if you are at the same level as your entrance.

Returns:

True if you are in your player owned house.

isMinimapLocked

public boolean isMinimapLocked()

Returns if the minimap has been locked/blacked out.

Returns:

True if the minimap has been blacked out.

getWildernessLevel

public int getWildernessLevel()

Retrieves your current wilderness level.

Returns:

Your current wilderness level as an integer, 0 if you are not in the wilderness

isMultiway

public boolean isMultiway()

Checks if you are in multiway combat.

Returns:

True if you are in multiway combat.

isWithinRange

public boolean isWithinRange(Entity entity,
                             int threshold)

Determines whether your character is within the specified range of an entity.

Parameters:

entity - The entity.

threshold - The threshold is the range you want to be in. The threshold is 1 if you are right next to an entity, 2 if there is one tile between etc.

Returns:

True if within the specified range.

isWithinRange

public boolean isWithinRange(Position position,
                             Entity entity,
                             int threshold)

Determines whether the specified position is within the specified range of an entity.

Parameters:

entity - The entity.

threshold - The threshold is the range you want to be in. The threshold is 1 if the position and entity are right next to each other, 2 if there is one tile between etc.

Returns:

True if within the specified range.