ra/runelite
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

Correct some tick/millis explanatory comments in runelite api (#6383)

Browse Source
This commit is contained in:
Twiglet1022
2018-11-25 18:10:57 +00:00
committed by Tomas Slusny
parent c4bea02599
commit ef358cc453
2 changed files with 21 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
runelite-api/src/main/java/net/runelite/api/Client.java
View File

@@ -971,21 +971,24 @@ public interface Client extends GameEngine
BufferProvider getBufferProvider(); BufferProvider getBufferProvider();
/** /**
* Gets the amount of ticks since the last mouse movement occurred. * Gets the amount of client ticks since the last mouse movement occurred.
* *
* @return amount of idle mouse ticks * @return amount of idle mouse ticks
* @see Constants#CLIENT_TICK_LENGTH
*/ */
int getMouseIdleTicks(); int getMouseIdleTicks();
/** /**
* Gets the number of milliseconds since the last mouse press occurred. * Gets the time at which the last mouse press occurred in milliseconds since
* the UNIX epoch.
*/ */
long getMouseLastPressedMillis(); long getMouseLastPressedMillis();
/** /**
* Gets the amount of ticks since the last keyboard press occurred. * Gets the amount of client ticks since the last keyboard press occurred.
* *
* @return amount of idle keyboard ticks * @return amount of idle keyboard ticks
* @see Constants#CLIENT_TICK_LENGTH
*/ */
int getKeyboardIdleTicks(); int getKeyboardIdleTicks();

15
runelite-api/src/main/java/net/runelite/api/Constants.java
View File

@@ -36,30 +36,37 @@ public class Constants
* The original width of the game when running in fixed mode. * The original width of the game when running in fixed mode.
*/ */
public static final int GAME_FIXED_WIDTH = 765; public static final int GAME_FIXED_WIDTH = 765;
/** /**
* The original height of the game when running in fixed mode. * The original height of the game when running in fixed mode.
*/ */
public static final int GAME_FIXED_HEIGHT = 503; public static final int GAME_FIXED_HEIGHT = 503;
/** /**
* Dimension representation of the width and height of the game in fixed mode. * Dimension representation of the width and height of the game in fixed mode.
*/ */
public static final Dimension GAME_FIXED_SIZE = new Dimension(GAME_FIXED_WIDTH, GAME_FIXED_HEIGHT); public static final Dimension GAME_FIXED_SIZE = new Dimension(GAME_FIXED_WIDTH, GAME_FIXED_HEIGHT);
/** /**
* The aspect ratio of the game when running in fixed mode. * The aspect ratio of the game when running in fixed mode.
*/ */
public static final double GAME_FIXED_ASPECT_RATIO = (double) GAME_FIXED_WIDTH / (double) GAME_FIXED_HEIGHT; public static final double GAME_FIXED_ASPECT_RATIO = (double) GAME_FIXED_WIDTH / (double) GAME_FIXED_HEIGHT;
/** /**
* The default camera zoom value. * The default camera zoom value.
*/ */
public static final int CLIENT_DEFAULT_ZOOM = 512; public static final int CLIENT_DEFAULT_ZOOM = 512;
/** /**
* The width and length of a chunk (8x8 tiles). * The width and length of a chunk (8x8 tiles).
*/ */
public static final int CHUNK_SIZE = 8; public static final int CHUNK_SIZE = 8;
/** /**
* The width and length of the scene (13 chunks x 8 tiles). * The width and length of the scene (13 chunks x 8 tiles).
*/ */
public static final int SCENE_SIZE = 104; public static final int SCENE_SIZE = 104;
/** /**
* The max allowed plane by the game. * The max allowed plane by the game.
* <p> * <p>
@@ -69,4 +76,12 @@ public class Constants
public static final int MAX_Z = 4; public static final int MAX_Z = 4;
public static final int TILE_FLAG_BRIDGE = 2; public static final int TILE_FLAG_BRIDGE = 2;
/**
* The number of milliseconds in a client tick.
* <p>
* This is the length of a single frame when the client is running at
* the maximum framerate of 50 fps.
*/
public static final int CLIENT_TICK_LENGTH = 20;
} }