org.osbot.rs07.api

Class Players

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.CollectionAPI<E>

org.osbot.rs07.api.filter.FilterAPI<E>

org.osbot.rs07.api.EntityAPI<Player>

org.osbot.rs07.api.Players

public class Players
extends EntityAPI<Player>

Represents the API for player functionality.

Field Summary

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
Players()

Method Summary

Modifier and Type	Method and Description
java.util.List<Player>	get(int x, int y) Gets a list of entities on the specified x and y coordinates on the plane of your current player.
java.util.List<Player>	getAll() Returns the local collection of entities.
Player	getLocalPlayer(int index) Gets a player based on it's index.
void	initializeModule()

Methods inherited from class org.osbot.rs07.api.EntityAPI

closest, closest, closest, closest, closest, closest, closest, closest, closest, closest, closest, closestThatContains, closestThatContains, iterator

Methods inherited from class org.osbot.rs07.api.filter.FilterAPI

filter, filter, singleFilter

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

Constructor Detail

Players

public Players()

Method Detail

getAll

public java.util.List<Player> getAll()

Returns the local collection of entities.

Specified by:

getAll in class CollectionAPI<Player>

Returns:

The list of local entities.

get

public java.util.List<Player> get(int x,
                                  int y)

Description copied from class: EntityAPI

Gets a list of entities on the specified x and y coordinates on the plane of your current player.

Specified by:

get in class EntityAPI<Player>

Parameters:

x - The x coordinate.

y - The y coordinate.

Returns:

An empty list if there are no entities found on this location, else a list of entities found on this location.

getLocalPlayer

public Player getLocalPlayer(int index)

Gets a player based on it's index.

Parameters:

index - The player's index.

Returns:

The player stored in the index of the players array.

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API