org.osbot.rs07.api

Class Camera

java.lang.Object

org.osbot.core.AbstractMethodProvider<Bot>

org.osbot.rs07.script.MethodProvider

org.osbot.rs07.script.API

org.osbot.rs07.api.Camera

public class Camera
extends API

Represents the API regarding camera functionality.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Camera.CameraDirection Represents the four camera key directions available.

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

Method Summary

Modifier and Type	Method and Description
boolean	canMiddleMouseControl() Checks if the middle mouse button can be used to control the camera
int	getLowestPitchAngle() Gets the lowest available camera pitch angle value available at the current position and camera rotation.
int	getPitchAngle() Gets the current camera angle of pitch.
int	getScaleZ() Gets the curremt camera z scale
int	getX() Gets the client camera x coordinate in the camera coordinate space.
int	getY() Gets the client camera y coordinate in the camera coordinate space.
int	getYawAngle() Gets the current camera angle of rotation.
int	getZ() Gets the client camera z coordinate in the camera coordinate space.
void	initializeModule()
boolean	isDefaultScaleZ()
boolean	moveCameraMouse(int yaw, int pitch) Moves the camera using the mouse for control
boolean	movePitch(int degrees) Rotates the pitch of the camera to the desired angle.
boolean	moveYaw(int degrees) Rotates the camera yaw to the specified angle.
boolean	setMiddleMouseControl(boolean enabled) A convenience method for setMiddleMouseControl(boolean, boolean) with closeSettings provided as true
boolean	setMiddleMouseControl(boolean enabled, boolean closeSettings) Enables or disabled the use of the middle mouse button to control the camera
void	setUseMouse(boolean useMouse) Sets the default camera control to be middle mouse
boolean	toBottom() Rotates the camera pitch to the lowest angle possible.
boolean	toEntity(Entity entity) Moves the camera to the specified entity, stopping when the entity is within the gamescreen.
boolean	toEntityMouse(Entity e) Moves the camera to an entity using the mouse for control
boolean	toEntityMouse(Position origin, Entity e) Moves the camera to an entity using the mouse for control
boolean	toPosition(Position position) Moves the camera to the specified position, stopping when the position is within the gamescreen.
boolean	toPositionMouse(Position position) Moves the camera to an entity using the mouse for control
boolean	toPositionMouse(Position from, Position to) Moves the camera to a position using the mouse for control
boolean	toTop() Rotates the camera pitch to the highest angle possible.

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

Camera

public Camera()

Method Detail

initializeModule

public void initializeModule()

Specified by:

initializeModule in class API

toEntity

public final boolean toEntity(Entity entity)

Moves the camera to the specified entity, stopping when the entity is within the gamescreen.

Parameters:

entity - The entity to rotate to.

Returns:

True if executed successfully.

toPosition

public final boolean toPosition(Position position)

Moves the camera to the specified position, stopping when the position is within the gamescreen.

Parameters:

position - The position to rotate to.

Returns:

True if executed successfully.

toTop

public final boolean toTop()

Rotates the camera pitch to the highest angle possible.

Returns:

True if executed successfully.

toBottom

public final boolean toBottom()

Rotates the camera pitch to the lowest angle possible.

Returns:

True if executed successfully.

moveYaw

public final boolean moveYaw(int degrees)

Rotates the camera yaw to the specified angle. Compass upside pointing to NORTH = 0, SOUTH = 180, WEST = 90, EAST = 270;

Without middle mouse; this method returns instantly and moves the camera movement on a different thread.

Parameters:

degrees - The angle to rotate the camera to.

Returns:

True if camera has moved

movePitch

public boolean movePitch(int degrees)

Rotates the pitch of the camera to the desired angle.

Without middle mouse; This method returns instantly and moves the camera movement on a different thread.

Parameters:

degrees - The angle to rotate the pitch to between 22 and 67. Note that 22 is not always the lowest available pitch, based on the terrain the lowest available pitch can be higher.

Returns:

True if camera has moved

setUseMouse

public void setUseMouse(boolean useMouse)

Sets the default camera control to be middle mouse

Parameters:

useMouse - True to use middle mouse, false to use keyboard

getX

public int getX()

Gets the client camera x coordinate in the camera coordinate space.

Returns:

The client camera x coordinate in the camera coordinate space.

getY

public int getY()

Gets the client camera y coordinate in the camera coordinate space.

Returns:

The client camera y coordinate in the camera coordinate space.

getZ

public int getZ()

Gets the client camera z coordinate in the camera coordinate space.

Returns:

The client camera z coordinate in the camera coordinate space.

getLowestPitchAngle

public int getLowestPitchAngle()

Gets the lowest available camera pitch angle value available at the current position and camera rotation.

Returns:

The lowest available camera pitch angle value at the current position and camera rotation.

getYawAngle

public int getYawAngle()

Gets the current camera angle of rotation.

Returns:

The camera's angle of rotation.

getScaleZ

public int getScaleZ()

Gets the curremt camera z scale

Returns:

The curremt camera z scale

isDefaultScaleZ

public boolean isDefaultScaleZ()

Returns:

True if the Camera zoom is at the original setting.

getPitchAngle

public int getPitchAngle()

Gets the current camera angle of pitch.

Returns:

The camera's angle of pitch.

canMiddleMouseControl

public boolean canMiddleMouseControl()

Checks if the middle mouse button can be used to control the camera

Returns:

True if the middle mouse button can be used to control the camera

setMiddleMouseControl

public boolean setMiddleMouseControl(boolean enabled)

A convenience method for setMiddleMouseControl(boolean, boolean) with closeSettings provided as true

setMiddleMouseControl

public boolean setMiddleMouseControl(boolean enabled,
                                     boolean closeSettings)

Enables or disabled the use of the middle mouse button to control the camera

Parameters:

enabled - True to enable the middle mouse button control, false to disable it

closeSettings - True to close the settings panel after changing the setting

Returns:

True if the middle mouse control is equal to the provided enabled state, otherwise false

toEntityMouse

public boolean toEntityMouse(Entity e)

Moves the camera to an entity using the mouse for control

Parameters:

e - The entity to move the camera towards

Returns:

True if the camera moved

toEntityMouse

public boolean toEntityMouse(Position origin,
                             Entity e)

Moves the camera to an entity using the mouse for control

Parameters:

origin - The origin position to base the camera rotation on

e - The entity to move the camera towards

Returns:

True if the camera has moved

toPositionMouse

public boolean toPositionMouse(Position position)

Moves the camera to an entity using the mouse for control

Parameters:

position - The position to move the camera towards

Returns:

True if the camera moved

toPositionMouse

public boolean toPositionMouse(Position from,
                               Position to)

Moves the camera to a position using the mouse for control

Parameters:

from - The origin position to base the camera rotation on

to - The target position to move the camera towards

Returns:

True if the camera has moved

moveCameraMouse

public boolean moveCameraMouse(int yaw,
                               int pitch)

Moves the camera using the mouse for control

Parameters:

yaw - The yaw to move to

pitch - The pich to move to

Returns:

True if the camera moved