diff --git a/docs/Client/classes/AbstractMidiController.md b/docs/Client/classes/AbstractMidiController.md index cb104a345..9617d3f70 100644 --- a/docs/Client/classes/AbstractMidiController.md +++ b/docs/Client/classes/AbstractMidiController.md @@ -1 +1,9 @@ # AbstractMidiController + +Defined in [`2006Scape Client/src/main/java/AbstractMidiController.java`](2006Scape Client/src/main/java/AbstractMidiController.java). + +Abstract Midi Controller helper class. + +```java +abstract class AbstractMidiController extends MidiPlayer +``` diff --git a/docs/Client/classes/AnimFrame.md b/docs/Client/classes/AnimFrame.md index d783bf009..d2e35c3b4 100644 --- a/docs/Client/classes/AnimFrame.md +++ b/docs/Client/classes/AnimFrame.md @@ -1 +1,14 @@ # AnimFrame + +Defined in [`2006Scape Client/src/main/java/AnimFrame.java`](2006Scape Client/src/main/java/AnimFrame.java). + +Anim Frame helper class. + +```java +public final class AnimFrame { +public static void init(int capacity) +public static void load(byte[] data) +public static void clear() +public static AnimFrame forId(int id) +public static boolean isNullFrame(int id) +``` diff --git a/docs/Client/classes/Animable.md b/docs/Client/classes/Animable.md index f27306e0e..6b5a2b836 100644 --- a/docs/Client/classes/Animable.md +++ b/docs/Client/classes/Animable.md @@ -1 +1,9 @@ # Animable + +Defined in [`2006Scape Client/src/main/java/Animable.java`](2006Scape Client/src/main/java/Animable.java). + +Animable helper class. + +```java +public class Animable extends NodeSub { +``` diff --git a/docs/Client/classes/Animation.md b/docs/Client/classes/Animation.md index 4709f033e..cab5127a2 100644 --- a/docs/Client/classes/Animation.md +++ b/docs/Client/classes/Animation.md @@ -1 +1,11 @@ # Animation + +Defined in [`2006Scape Client/src/main/java/Animation.java`](2006Scape Client/src/main/java/Animation.java). + +Animation helper class. + +```java +public final class Animation { +public static void unpackConfig(StreamLoader streamLoader) +public int getFrameDelay(int frameIndex) +``` diff --git a/docs/Client/classes/BZip2Decompressor.md b/docs/Client/classes/BZip2Decompressor.md index 35b68720d..85a981fd6 100644 --- a/docs/Client/classes/BZip2Decompressor.md +++ b/docs/Client/classes/BZip2Decompressor.md @@ -1 +1,10 @@ # BZip2Decompressor + +Defined in [`2006Scape Client/src/main/java/BZip2Decompressor.java`](2006Scape Client/src/main/java/BZip2Decompressor.java). + +BZip2Decompressor helper class. + +```java +final class BZip2Decompressor { +public static int decompress(byte[] outputBuffer, int outputLength, byte[] inputBuffer, int inputLength, int startIndex) +``` diff --git a/docs/Client/classes/BZip2State.md b/docs/Client/classes/BZip2State.md index b43c58551..e99704168 100644 --- a/docs/Client/classes/BZip2State.md +++ b/docs/Client/classes/BZip2State.md @@ -1 +1,9 @@ # BZip2State + +Defined in [`2006Scape Client/src/main/java/BZip2State.java`](2006Scape Client/src/main/java/BZip2State.java). + +BZip2State helper class. + +```java +final class BZip2State { +``` diff --git a/docs/Client/classes/Background.md b/docs/Client/classes/Background.md index 5767328a9..3638d6e15 100644 --- a/docs/Client/classes/Background.md +++ b/docs/Client/classes/Background.md @@ -1 +1,16 @@ # Background + +Defined in [`2006Scape Client/src/main/java/Background.java`](2006Scape Client/src/main/java/Background.java). + +Background helper class. + +```java +public final class Background extends DrawingArea { +public Background(StreamLoader streamLoader, String s, int i) +public void downscaleHalf() +public void normalize() +public void flipHorizontal() +public void flipVertical() +public void adjustPalette(int i, int j, int k) +public void draw(int i, int k) +``` diff --git a/docs/Client/classes/BoundaryObject.md b/docs/Client/classes/BoundaryObject.md index 0f2e5d47a..959be86c5 100644 --- a/docs/Client/classes/BoundaryObject.md +++ b/docs/Client/classes/BoundaryObject.md @@ -1 +1,10 @@ # BoundaryObject + +Defined in [`2006Scape Client/src/main/java/BoundaryObject.java`](2006Scape Client/src/main/java/BoundaryObject.java). + +Boundary Object helper class. + +```java +public final class BoundaryObject { +public BoundaryObject() {} +``` diff --git a/docs/Client/classes/CachePlaceholder.md b/docs/Client/classes/CachePlaceholder.md index b87dc4b26..f9d68126e 100644 --- a/docs/Client/classes/CachePlaceholder.md +++ b/docs/Client/classes/CachePlaceholder.md @@ -1 +1,10 @@ # CachePlaceholder + +Defined in [`2006Scape Client/src/main/java/CachePlaceholder.java`](2006Scape Client/src/main/java/CachePlaceholder.java). + +Cache Placeholder helper class. + +```java +public final class CachePlaceholder { +public CachePlaceholder() +``` diff --git a/docs/Client/classes/Censor.md b/docs/Client/classes/Censor.md index 2b230649a..4872a4d5e 100644 --- a/docs/Client/classes/Censor.md +++ b/docs/Client/classes/Censor.md @@ -1 +1,11 @@ # Censor + +Defined in [`2006Scape Client/src/main/java/Censor.java`](2006Scape Client/src/main/java/Censor.java). + +Censor helper class. + +```java +final class Censor { +public static void loadConfig(StreamLoader streamLoader) +public static String doCensor(String s) +``` diff --git a/docs/Client/classes/Client.md b/docs/Client/classes/Client.md index e03a47e34..0c9a1a547 100644 --- a/docs/Client/classes/Client.md +++ b/docs/Client/classes/Client.md @@ -1 +1,10 @@ # Client + +Defined in [`2006Scape Client/src/main/java/Client.java`](2006Scape Client/src/main/java/Client.java). + +Client helper class. + +```java +public final class Client { +public static void main(String[] args) +``` diff --git a/docs/Client/classes/ClientSettings.md b/docs/Client/classes/ClientSettings.md index 86f4a6a7e..f593adda7 100644 --- a/docs/Client/classes/ClientSettings.md +++ b/docs/Client/classes/ClientSettings.md @@ -1 +1,11 @@ # ClientSettings + +Defined in [`2006Scape Client/src/main/java/ClientSettings.java`](2006Scape Client/src/main/java/ClientSettings.java). + +ClientSettings @author Andrew (I'm A Boss on Rune-Server and Mr Extremez on Mopar & Runelocus) + +```java +public class ClientSettings { +public static final BigInteger RSA_MODULUS = new BigInteger("91553247461173033466542043374346300088148707506479543786501537350363031301992107112953015516557748875487935404852620239974482067336878286174236183516364787082711186740254168914127361643305190640280157664988536979163450791820893999053469529344247707567448479470137716627440246788713008490213212272520901741443"); +public static final BigInteger RSA_EXPONENT = new BigInteger("65537"); +``` diff --git a/docs/Client/classes/CollisionMap.md b/docs/Client/classes/CollisionMap.md index 92d557a12..42ff45cd9 100644 --- a/docs/Client/classes/CollisionMap.md +++ b/docs/Client/classes/CollisionMap.md @@ -1 +1,20 @@ # CollisionMap + +Defined in [`2006Scape Client/src/main/java/CollisionMap.java`](2006Scape Client/src/main/java/CollisionMap.java). + +Collision Map helper class. + +```java +final class CollisionMap { +public CollisionMap() +public void reset() +public void addWall(int i, int j, int k, int l, boolean flag) +public void addObject(boolean flag, int j, int k, int l, int i1, int j1) +public void blockTile(int i, int k) +public void removeWall(int i, int j, boolean flag, int k, int l) +public void removeObject(int i, int j, int k, int l, int i1, boolean flag) +public void unblockTile(int j, int k) +public boolean canReachWall(int i, int j, int k, int i1, int j1, int k1) +public boolean canReachObject(int i, int j, int k, int l, int i1, int j1) +public boolean canReachArea(int i, int j, int k, int l, int i1, int j1, int k1) +``` diff --git a/docs/Client/classes/CullingCluster.md b/docs/Client/classes/CullingCluster.md index 31f191644..b4d62a535 100644 --- a/docs/Client/classes/CullingCluster.md +++ b/docs/Client/classes/CullingCluster.md @@ -1 +1,9 @@ # CullingCluster + +Defined in [`2006Scape Client/src/main/java/CullingCluster.java`](2006Scape Client/src/main/java/CullingCluster.java). + +Culling Cluster helper class. + +```java +final class CullingCluster { +``` diff --git a/docs/Client/classes/Decompressor.md b/docs/Client/classes/Decompressor.md index a2e4e17dc..43a45590c 100644 --- a/docs/Client/classes/Decompressor.md +++ b/docs/Client/classes/Decompressor.md @@ -1 +1,12 @@ # Decompressor + +Defined in [`2006Scape Client/src/main/java/Decompressor.java`](2006Scape Client/src/main/java/Decompressor.java). + +Decompressor helper class. + +```java +final class Decompressor { +public Decompressor(RandomAccessFile randomaccessfile, RandomAccessFile randomaccessfile1, int j) +public synchronized byte[] decompress(int i) +public synchronized boolean writeEntry(int i, byte abyte0[], int j) +``` diff --git a/docs/Client/classes/DrawingArea.md b/docs/Client/classes/DrawingArea.md index 8c56ec234..5a459f5bc 100644 --- a/docs/Client/classes/DrawingArea.md +++ b/docs/Client/classes/DrawingArea.md @@ -1 +1,19 @@ # DrawingArea + +Defined in [`2006Scape Client/src/main/java/DrawingArea.java`](2006Scape Client/src/main/java/DrawingArea.java). + +Drawing Area helper class. + +```java +public class DrawingArea extends NodeSub { +public static void initDrawingArea(int i, int j, int ai[]) +public static void defaultDrawingAreaSize() +public static void setDrawingArea(int i, int j, int k, int l) +public static void setAllPixelsToZero() +public static void fillArea(int _color, int _y, int _width, int _height, int _opacity, int _x) +public static void fillArea(int _height, int _y, int _color, int _width, int _x) +public static void fillPixels(int _y, int _height, int _color, int _x, int _width) +public static void drawFrameRounded(int _y, int _height, int _opacity, int _color, int _width, int _x) +public static void drawHorizontalLine(int i, int j, int k, int l) +public static void drawVerticalLine(int _y, int _color, int _height, int _x) +``` diff --git a/docs/Client/classes/DynamicObject.md b/docs/Client/classes/DynamicObject.md index 3ce08aa85..c6f8d466d 100644 --- a/docs/Client/classes/DynamicObject.md +++ b/docs/Client/classes/DynamicObject.md @@ -1 +1,11 @@ # DynamicObject + +Defined in [`2006Scape Client/src/main/java/DynamicObject.java`](2006Scape Client/src/main/java/DynamicObject.java). + +Dynamic Object helper class. + +```java +final class DynamicObject extends Animable { +public Model getRotatedModel() +public DynamicObject(int i, int j, int k, int l, int i1, int j1, int k1, int l1, boolean flag) +``` diff --git a/docs/Client/classes/Entity.md b/docs/Client/classes/Entity.md index 17891d820..d629571c7 100644 --- a/docs/Client/classes/Entity.md +++ b/docs/Client/classes/Entity.md @@ -1 +1,14 @@ # Entity + +Defined in [`2006Scape Client/src/main/java/Entity.java`](2006Scape Client/src/main/java/Entity.java). + +Entity helper class. + +```java +public class Entity extends Animable { +public final void setPos(int i, int j, boolean flag) +public final void clearMovement() +public final void updateHitData(int j, int k, int l) +public final void moveInDir(boolean flag, int i) +public boolean isVisible() +``` diff --git a/docs/Client/classes/EntityDef.md b/docs/Client/classes/EntityDef.md index 1cf35a9fa..7fff09466 100644 --- a/docs/Client/classes/EntityDef.md +++ b/docs/Client/classes/EntityDef.md @@ -1 +1,16 @@ # EntityDef + +Defined in [`2006Scape Client/src/main/java/EntityDef.java`](2006Scape Client/src/main/java/EntityDef.java). + +Entity Def helper class. + +```java +public final class EntityDef { +public static EntityDef forID(int i) +public Model getModel() +public EntityDef transform() +public static void unpackConfig(StreamLoader streamLoader) +public static void nullLoader() +public Model getAnimatedModel(int primaryFrame, int secondaryFrame, int[] frameData) +public static MRUCache mruNodes = new MRUCache(30); +``` diff --git a/docs/Client/classes/FloorOverlay.md b/docs/Client/classes/FloorOverlay.md index af642fe2b..f3c2a190e 100644 --- a/docs/Client/classes/FloorOverlay.md +++ b/docs/Client/classes/FloorOverlay.md @@ -1 +1,11 @@ # FloorOverlay + +Defined in [`2006Scape Client/src/main/java/FloorOverlay.java`](2006Scape Client/src/main/java/FloorOverlay.java). + +Floor Overlay helper class. + +```java +public final class FloorOverlay { +public static void unpackConfig(StreamLoader streamLoader) +public static String getTodaysDate() +``` diff --git a/docs/Client/classes/FrameBase.md b/docs/Client/classes/FrameBase.md index f98d73ede..b3ef79f28 100644 --- a/docs/Client/classes/FrameBase.md +++ b/docs/Client/classes/FrameBase.md @@ -1 +1,10 @@ # FrameBase + +Defined in [`2006Scape Client/src/main/java/FrameBase.java`](2006Scape Client/src/main/java/FrameBase.java). + +Frame Base helper class. + +```java +public final class FrameBase { +public FrameBase(Stream stream) +``` diff --git a/docs/Client/classes/Game.md b/docs/Client/classes/Game.md index dcc95dd70..33eb64cb0 100644 --- a/docs/Client/classes/Game.md +++ b/docs/Client/classes/Game.md @@ -1 +1,177 @@ # Game + +Defined in [`2006Scape Client/src/main/java/Game.java`](2006Scape Client/src/main/java/Game.java). + +NOTICE: IF YOU CHANGE ANYTHING IN GAME.JAVA, PLEASE COPY-PASTE THE WHOLE CLASS OVER TO LOCALGAME.JAVA THIS IS TO ALLOW LOCAL PARABOT TO CONTINUE TO WORK + +```java +public class Game extends RSApplet { +public static int random(final float range) +public static String intToKOrMilLongName(int i) +public static String getFileNameWithoutExtension(String fileName) +public String indexLocation(int cacheIndex, int index) +public void repackCacheIndex(int cacheIndex) +public byte[] fileToByteArray(int cacheIndex, int index) +public void musics() +public byte[] GetMusic(int Index) +public void sendFrame126(String str,int i) +public boolean menuHasAddFriend(int j) +public void drawChatArea() +public void init() +public void startRunnable(Runnable runnable, int i) +public Socket openSocket(int i) throws IOException +public boolean processMenuClick() +public void saveMidi(boolean flag, byte abyte0[]) +public void constructMapRegion() +public void unlinkMRUNodes() +public void generateMinimap(int i) +public void spawnGroundItem(int i, int j) +public void addNpcsToScene(boolean flag) +public boolean replayWave() +public void loadError() +public void buildInterfaceMenu(int i, RSInterface parentInterface, int k, int l, int i1, int j1) +public void drawScrollThumb(int j, int k, int l, int i1, int j1) +public void updateNPCs(Stream stream, int i) +public void processChatModeClick() +public void applyVarp(int i) +public void updateEntities() +public void delFriend(long l) +public void drawButton(boolean enabled, int x, int y, int width) +public void drawCheckbox(boolean enabled, int x, int y) +public void drawTabArea() +public void animateTextures(int j) +public void updateEntityText() +public void calcCameraPos() +public void drawMenu() +public void addFriend(long l) +public int getTileHeight(int plane, int worldY, int worldX) +public static String intToKOrMil(int j) +public static String intToShortLetter(long number) +public void resetLogout() +public void resetCharacterOptions() +public void addLocalNPCs(int i, Stream stream) +public void processGameLoop() +public void addPlayersToScene(boolean flag) +public boolean promptUserForInput(RSInterface widget) +public void processPlayerUpdateMasks(Stream stream) +public void drawMinimapLoc(int i, int k, int l, int i1, int j1) +public void loadTitleScreen() +public static void setHighMem() +public void loadingStages() +public int checkMapLoadStatus() +public void processProjectiles() +public AppletContext getAppletContext() +public void drawLogo() +public void processOnDemandQueue() +public void calcFlamesPosition() +public boolean saveWave(byte abyte0[], int i) +public void resetInterfaceAnimation(int i) +public void drawHeadIcon() +public void mainGameProcessor() +public void locatePendingSpawns() +public void handleScrollbarInput(int i, int j, int k, int l, RSInterface scrollInterface, int i1, boolean flag, int j1) +public boolean walkToObject(int i, int j, int k) +public StreamLoader streamLoaderForName(int i, String s, String s1, int j, int k) +public void dropClient() +public void drawTextOnScreen(String s, String s1) +public void doAction(int i) +public void updateRestrictedArea() +public void run() +public void build3dScreenMenu() +public void cleanUpForQuit() +public void printDebug() +public void processInput() +public void buildChatAreaMenu(int j) +public void drawFriendsListOrWelcomeScreen(RSInterface interfaceComponent) +public String formatDate(int i) +public void drawSplitpublicChat() +public void screenshot(boolean sendMessage, String... subfolders) +public void pushMessage(String s, int i, String s1) +public void processMinimapActions() +public void processTabClick() +public void run() +public void resetImageProducers() +public void resetAllImageProducers() +public void resetImageProducers2() +public void drawMinimapHint(Sprite sprite, int y, int x) +public void processRightClick() +public int blendColors(int i, int j, int k) +public void login(String s, String s1, boolean flag) +public boolean doWalkTo(int i, int j, int k, int i1, int j1, int k1, int l1, int i2, int j2, boolean flag, int k2) +public void processNpcUpdateMasks(Stream stream) +public void buildAtNPCMenu(EntityDef entityDef, int i, int j, int k) +public void buildAtPlayerMenu(int i, int j, Player player, int k) +public void locateSceneObject(PendingSpawn pendingSpawn) +public final void processSoundQueue() +public void addLocalPlayers(Stream stream, int i) +public void processMainScreenClick() +public String interfaceIntToString(int j) +public void showErrorScreen() +public URL getCodeBase() +public void animateNpcs() +public void updateEntityMovement(Entity entity) +public void updateForcedMovement(Entity entity) +public void updateInterpolatedMovement(Entity entity) +public void updateWalkingStep(Entity entity) +public void updateEntityFacing(Entity entity) +public void updateEntityAnimation(Entity entity) +public void drawGameScreen() +public boolean buildFriendsListMenu(RSInterface listInterface) +public void processGraphicsObjects() +public void drawInterface(int scrollPos, int k, RSInterface widget, int l) +public void randomizeBackground(Background background) +public void decodePlayerUpdateMask(int i, int j, Stream stream, Player player) +public void updateCameraPosition() +public void processDrawing() +public boolean isFriendOrSelf(String s) +public static String combatDiffColor(int i, int j) +public void setWaveVolume(int i) +public void draw3dScreen() +public void addIgnore(long l) +public void animatePlayers() +public void processPendingSpawns() +public void determineMenuSize() +public void updateSelfMovement(Stream stream) +public void nullLoader() +public boolean updateInterfaceAnimations(int i, int j) +public int determineCameraPlane() +public int getCurrentPlane() +public void delIgnore(long l) +public String getParameter(String s) +public int extractInterfaceValues(RSInterface component, int j) +public void drawTooltip() +public void drawMinimap() +public void npcScreenPos(Entity entity, int i) +public void calcEntityScreenPos(int i, int j, int l) +public void buildSplitPrivateChatMenu() +public void queuePendingSpawn(int j, int k, int l, int i1, int j1, int k1, int l1, int i2, int j2) +public boolean interfaceIsSelected(RSInterface component) +public DataInputStream openJagGrabInputStream(String s) throws IOException +public void doFlamesDrawing() +public void updateOtherPlayers(Stream stream) +public void drawLoginScreen(boolean flag) +public void drawFlames() +public void raiseWelcomeScreen() +public void handleMapPackets(Stream stream, int j) +public static void setLowMem() +public void updateNpcList(Stream stream) +public void processLoginScreenInput() +public void markMinimap(Sprite sprite, int i, int j) +public void updateSceneObjects(int i, int j, int k, int l, int i1, int j1, int k1) +public void updatePlayers(int i, Stream stream) +public void setCameraPos(int j, int k, int l, int i1, int j1, int k1) +public boolean parsePacket() +public void run() +public void renderGameView() +public void closeOpenInterfaces() +public Game() +public static final String validUserPassChars = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789!\"\243$%^&*()-_=+[{]};:'@#~,<.>/?\\| "; +public void keyPressed(KeyEvent keyevent) +public long calculateTotalExp() +public int calculateTotalLevels() +public void definitionSearch(String name, int type) +public void openInterface(int interfaceID) +public void openSideInterface(int tab, int interfaceID) +public final void mouseWheelMoved(MouseWheelEvent e) +public String getClipBoard() +``` diff --git a/docs/Client/classes/GraphicsObject.md b/docs/Client/classes/GraphicsObject.md index 721d825a6..4673bb68c 100644 --- a/docs/Client/classes/GraphicsObject.md +++ b/docs/Client/classes/GraphicsObject.md @@ -1 +1,12 @@ # GraphicsObject + +Defined in [`2006Scape Client/src/main/java/GraphicsObject.java`](2006Scape Client/src/main/java/GraphicsObject.java). + +Graphics Object helper class. + +```java +final class GraphicsObject extends Animable { +public GraphicsObject(int plane, int startCycle, int delay, int spotAnimId, int height, int y, int x) +public Model getRotatedModel() +public void update(int elapsed) +``` diff --git a/docs/Client/classes/Ground.md b/docs/Client/classes/Ground.md index 96bee8b3a..48d6c9eb2 100644 --- a/docs/Client/classes/Ground.md +++ b/docs/Client/classes/Ground.md @@ -1 +1,10 @@ # Ground + +Defined in [`2006Scape Client/src/main/java/Ground.java`](2006Scape Client/src/main/java/Ground.java). + +Ground helper class. + +```java +public final class Ground extends Node { +public Ground(int i, int j, int k) +``` diff --git a/docs/Client/classes/IDK.md b/docs/Client/classes/IDK.md index bcf4f0746..bd071f26a 100644 --- a/docs/Client/classes/IDK.md +++ b/docs/Client/classes/IDK.md @@ -1 +1,14 @@ # IDK + +Defined in [`2006Scape Client/src/main/java/IDK.java`](2006Scape Client/src/main/java/IDK.java). + +IDK helper class. + +```java +public final class IDK { +public static void unpackConfig(StreamLoader streamLoader) +public boolean ready() +public Model getBodyModel() +public boolean headLoaded() +public Model getHeadModel() +``` diff --git a/docs/Client/classes/ISAACRandomGen.md b/docs/Client/classes/ISAACRandomGen.md index dbbe071b4..40b87d291 100644 --- a/docs/Client/classes/ISAACRandomGen.md +++ b/docs/Client/classes/ISAACRandomGen.md @@ -1 +1,11 @@ # ISAACRandomGen + +Defined in [`2006Scape Client/src/main/java/ISAACRandomGen.java`](2006Scape Client/src/main/java/ISAACRandomGen.java). + +ISAACRandom Gen helper class. + +```java +public final class ISAACRandomGen { +public ISAACRandomGen(int seed[]) +public int getNextKey() +``` diff --git a/docs/Client/classes/Instrument.md b/docs/Client/classes/Instrument.md index db285e1b1..e2fb56ff7 100644 --- a/docs/Client/classes/Instrument.md +++ b/docs/Client/classes/Instrument.md @@ -1 +1,13 @@ # Instrument + +Defined in [`2006Scape Client/src/main/java/Instrument.java`](2006Scape Client/src/main/java/Instrument.java). + +Instrument helper class. + +```java +final class Instrument { +public static void initializeTables() +public int[] synthesize(int length, int rate) +public void decode(Stream stream) +public Instrument() +``` diff --git a/docs/Client/classes/Item.md b/docs/Client/classes/Item.md index c97bbb005..dfd23fdad 100644 --- a/docs/Client/classes/Item.md +++ b/docs/Client/classes/Item.md @@ -1 +1,11 @@ # Item + +Defined in [`2006Scape Client/src/main/java/Item.java`](2006Scape Client/src/main/java/Item.java). + +Item helper class. + +```java +final class Item extends Animable { +public final Model getRotatedModel() +public Item() +``` diff --git a/docs/Client/classes/ItemDef.md b/docs/Client/classes/ItemDef.md index e23c6dddd..92cd6e1c1 100644 --- a/docs/Client/classes/ItemDef.md +++ b/docs/Client/classes/ItemDef.md @@ -1 +1,20 @@ # ItemDef + +Defined in [`2006Scape Client/src/main/java/ItemDef.java`](2006Scape Client/src/main/java/ItemDef.java). + +Item Def helper class. + +```java +public final class ItemDef { +public static void resetCache() +public boolean areDialogueModelsCached(int gender) +public static void unpackConfig(StreamLoader streamLoader) +public Model getDialogueModel(int gender) +public boolean areWearModelsCached(int gender) +public Model getWearModel(int gender) +public static ItemDef lookup(int i) +public static Sprite getSprite(int i, int j, int k) +public Model getModel(int amount) +public Model getInterfaceModel(int amount) +public static MRUCache modelCache = new MRUCache(50); +``` diff --git a/docs/Client/classes/ItemPile.md b/docs/Client/classes/ItemPile.md index ef677ab1b..a7a7f6fab 100644 --- a/docs/Client/classes/ItemPile.md +++ b/docs/Client/classes/ItemPile.md @@ -1 +1,9 @@ # ItemPile + +Defined in [`2006Scape Client/src/main/java/ItemPile.java`](2006Scape Client/src/main/java/ItemPile.java). + +Item Pile helper class. + +```java +final class ItemPile { +``` diff --git a/docs/Client/classes/LocalGame.md b/docs/Client/classes/LocalGame.md index 1baa02b59..a15de5459 100644 --- a/docs/Client/classes/LocalGame.md +++ b/docs/Client/classes/LocalGame.md @@ -1 +1,10 @@ # LocalGame + +Defined in [`2006Scape Client/src/main/java/LocalGame.java`](2006Scape Client/src/main/java/LocalGame.java). + +NOTICE: IF YOU CHANGE ANYTHING IN GAME.JAVA, PLEASE COPY-PASTE THE WHOLE CLASS OVER TO LOCALGAME.JAVA THIS IS TO ALLOW LOCAL PARABOT TO CONTINUE TO WORK + +```java +public class LocalGame extends Game { +public LocalGame() +``` diff --git a/docs/Client/classes/MRUCache.md b/docs/Client/classes/MRUCache.md index d56e05c00..aa434f1bd 100644 --- a/docs/Client/classes/MRUCache.md +++ b/docs/Client/classes/MRUCache.md @@ -1 +1,13 @@ # MRUCache + +Defined in [`2006Scape Client/src/main/java/MRUCache.java`](2006Scape Client/src/main/java/MRUCache.java). + +MRUCache helper class. + +```java +public final class MRUCache { +public MRUCache(int i) +public NodeSub get(long key) +public void put(NodeSub node, long key) +public void unlinkAll() +``` diff --git a/docs/Client/classes/Main.md b/docs/Client/classes/Main.md index 909e8f5a5..e48d03a7e 100644 --- a/docs/Client/classes/Main.md +++ b/docs/Client/classes/Main.md @@ -1 +1,10 @@ # Main + +Defined in [`2006Scape Client/src/main/java/Main.java`](2006Scape Client/src/main/java/Main.java). + +Main helper class. + +```java +public final class Main { +public static void main(String[] args) +``` diff --git a/docs/Client/classes/Midi.md b/docs/Client/classes/Midi.md index d2d896712..8ae304921 100644 --- a/docs/Client/classes/Midi.md +++ b/docs/Client/classes/Midi.md @@ -1 +1,17 @@ # Midi + +Defined in [`2006Scape Client/src/main/java/Midi.java`](2006Scape Client/src/main/java/Midi.java). + +Midi file playing. @author Primadude. + +```java +public class Midi implements Runnable { +public String getMidiFileName() +public String getMidiSaveDir() +public void setMidiFileName(String midiFileName) +public void setMidiSaveDir(String midiSaveDir) +public void run() +public boolean setVolume(double value) +public void fadeOut() +public void startMidi() +``` diff --git a/docs/Client/classes/MidiFile.md b/docs/Client/classes/MidiFile.md index 2d6987725..92294f414 100644 --- a/docs/Client/classes/MidiFile.md +++ b/docs/Client/classes/MidiFile.md @@ -1 +1,11 @@ # MidiFile + +Defined in [`2006Scape Client/src/main/java/MidiFile.java`](2006Scape Client/src/main/java/MidiFile.java). + +Midi File helper class. + +```java +final class MidiFile +public static void reset() +public MidiFile() +``` diff --git a/docs/Client/classes/MidiHandler.md b/docs/Client/classes/MidiHandler.md index b468a763a..ee3870514 100644 --- a/docs/Client/classes/MidiHandler.md +++ b/docs/Client/classes/MidiHandler.md @@ -1 +1,9 @@ # MidiHandler + +Defined in [`2006Scape Client/src/main/java/MidiHandler.java`](2006Scape Client/src/main/java/MidiHandler.java). + +Handles midi related functionality. + +```java +public interface MidiHandler extends Runnable { +``` diff --git a/docs/Client/classes/MidiPlayer.md b/docs/Client/classes/MidiPlayer.md index dc639d434..c890a5077 100644 --- a/docs/Client/classes/MidiPlayer.md +++ b/docs/Client/classes/MidiPlayer.md @@ -1 +1,10 @@ # MidiPlayer + +Defined in [`2006Scape Client/src/main/java/MidiPlayer.java`](2006Scape Client/src/main/java/MidiPlayer.java). + +Midi Player helper class. + +```java +abstract class MidiPlayer { +public MidiPlayer() +``` diff --git a/docs/Client/classes/Model.md b/docs/Client/classes/Model.md index 50d91a623..90c112598 100644 --- a/docs/Client/classes/Model.md +++ b/docs/Client/classes/Model.md @@ -1 +1,36 @@ # Model + +Defined in [`2006Scape Client/src/main/java/Model.java`](2006Scape Client/src/main/java/Model.java). + +Model helper class. + +```java +public final class Model extends Animable { +public static void clearCache() +public static void init(int i, OnDemandFetcherParent onDemandFetcherParent) +public static void loadModelData(byte abyte0[], int j) +public static void unload(int j) +public static Model create(int j) +public static boolean isLoaded(int i) +public Model(int i, Model models[]) +public Model(Model models[]) +public Model(boolean flag, boolean flag1, boolean flag2, Model model) +public Model(boolean flag, boolean flag1, Model model) +public void copyFromModel(Model src, boolean shareColor) +public void calculateBounds() +public void calculateBoundsY() +public void buildVertexGroups() +public void applyFrame(int i) +public void applyFrames(int ai[], int j, int k) +public void calculateNormals() +public void rotateX(int i) +public void translate(int i, int j, int l) +public void recolor(int i, int j) +public void mirror() +public void scaleModel(int i, int j, int l) +public void applyLighting(int i, int j, int k, int l, int i1, boolean flag) +public void applyShading(int i, int j, int k, int l, int i1) +public void transformVertices(int j, int k, int l, int i1, int j1, int k1) +public void render(int i, int j, int k, int l, int i1, int j1, int k1, int l1, int i2) +public static final Model placeholderModel = new Model(); +``` diff --git a/docs/Client/classes/ModelHeader.md b/docs/Client/classes/ModelHeader.md index 19c85c44f..3a33daf3b 100644 --- a/docs/Client/classes/ModelHeader.md +++ b/docs/Client/classes/ModelHeader.md @@ -1 +1,10 @@ # ModelHeader + +Defined in [`2006Scape Client/src/main/java/ModelHeader.java`](2006Scape Client/src/main/java/ModelHeader.java). + +Model Header helper class. + +```java +final class ModelHeader { +public ModelHeader() +``` diff --git a/docs/Client/classes/MouseDetection.md b/docs/Client/classes/MouseDetection.md index 303581a31..730e22d08 100644 --- a/docs/Client/classes/MouseDetection.md +++ b/docs/Client/classes/MouseDetection.md @@ -1 +1,11 @@ # MouseDetection + +Defined in [`2006Scape Client/src/main/java/MouseDetection.java`](2006Scape Client/src/main/java/MouseDetection.java). + +Mouse Detection helper class. + +```java +final class MouseDetection implements Runnable { +public void run() +public MouseDetection(Game client1) +``` diff --git a/docs/Client/classes/MuLawInputStream.md b/docs/Client/classes/MuLawInputStream.md index b6914ed65..4e524c4b7 100644 --- a/docs/Client/classes/MuLawInputStream.md +++ b/docs/Client/classes/MuLawInputStream.md @@ -1 +1,11 @@ # MuLawInputStream + +Defined in [`2006Scape Client/src/main/java/MuLawInputStream.java`](2006Scape Client/src/main/java/MuLawInputStream.java). + +Converts 16-bit PCM samples stored in an integer buffer to 8-bit mu-law encoded bytes. + +```java +final class MuLawInputStream extends InputStream { +public final synchronized int read(byte[] is, int i, int i_4_) +public final int read() +``` diff --git a/docs/Client/classes/NPC.md b/docs/Client/classes/NPC.md index e457388a9..ed5fc467a 100644 --- a/docs/Client/classes/NPC.md +++ b/docs/Client/classes/NPC.md @@ -1 +1,11 @@ # NPC + +Defined in [`2006Scape Client/src/main/java/NPC.java`](2006Scape Client/src/main/java/NPC.java). + +NPC helper class. + +```java +public final class NPC extends Entity { +public Model getRotatedModel() +public boolean isVisible() +``` diff --git a/docs/Client/classes/Node.md b/docs/Client/classes/Node.md index 6d9836e17..9322d5dbc 100644 --- a/docs/Client/classes/Node.md +++ b/docs/Client/classes/Node.md @@ -1 +1,11 @@ # Node + +Defined in [`2006Scape Client/src/main/java/Node.java`](2006Scape Client/src/main/java/Node.java). + +Node helper class. + +```java +public class Node { +public final void unlink() +public Node() +``` diff --git a/docs/Client/classes/NodeHashTable.md b/docs/Client/classes/NodeHashTable.md index faf959017..00a8141b0 100644 --- a/docs/Client/classes/NodeHashTable.md +++ b/docs/Client/classes/NodeHashTable.md @@ -1 +1,12 @@ # NodeHashTable + +Defined in [`2006Scape Client/src/main/java/NodeHashTable.java`](2006Scape Client/src/main/java/NodeHashTable.java). + +Node Hash Table helper class. + +```java +final class NodeHashTable { +public NodeHashTable() +public Node findNodeById(long id) +public void insertNode(Node node, long id) +``` diff --git a/docs/Client/classes/NodeList.md b/docs/Client/classes/NodeList.md index da029b165..b09bf6171 100644 --- a/docs/Client/classes/NodeList.md +++ b/docs/Client/classes/NodeList.md @@ -1 +1,18 @@ # NodeList + +Defined in [`2006Scape Client/src/main/java/NodeList.java`](2006Scape Client/src/main/java/NodeList.java). + +Node List helper class. + +```java +final class NodeList { +public NodeList() +public void insertHead(Node node) +public void insertTail(Node node) +public Node popHead() +public Node reverseGetFirst() +public Node getFirst() +public Node reverseGetNext() +public Node getNext() +public void removeAll() +``` diff --git a/docs/Client/classes/NodeSub.md b/docs/Client/classes/NodeSub.md index 17dd6ea95..bdc760aae 100644 --- a/docs/Client/classes/NodeSub.md +++ b/docs/Client/classes/NodeSub.md @@ -1 +1,11 @@ # NodeSub + +Defined in [`2006Scape Client/src/main/java/NodeSub.java`](2006Scape Client/src/main/java/NodeSub.java). + +Node Sub helper class. + +```java +public class NodeSub extends Node { +public final void unlinkSub() +public NodeSub() +``` diff --git a/docs/Client/classes/NodeSubList.md b/docs/Client/classes/NodeSubList.md index b78dad170..a1688625d 100644 --- a/docs/Client/classes/NodeSubList.md +++ b/docs/Client/classes/NodeSubList.md @@ -1 +1,15 @@ # NodeSubList + +Defined in [`2006Scape Client/src/main/java/NodeSubList.java`](2006Scape Client/src/main/java/NodeSubList.java). + +Node Sub List helper class. + +```java +final class NodeSubList { +public NodeSubList() +public void insertHead(NodeSub nodeSub) +public NodeSub popTail() +public NodeSub reverseGetFirst() +public NodeSub reverseGetNext() +public int getNodeCount() +``` diff --git a/docs/Client/classes/ObjectDef.md b/docs/Client/classes/ObjectDef.md index de9522ded..88c2fb738 100644 --- a/docs/Client/classes/ObjectDef.md +++ b/docs/Client/classes/ObjectDef.md @@ -1 +1,19 @@ # ObjectDef + +Defined in [`2006Scape Client/src/main/java/ObjectDef.java`](2006Scape Client/src/main/java/ObjectDef.java). + +Object Def helper class. + +```java +public final class ObjectDef { +public static ObjectDef forID(int i) +public void requestModels(OnDemandFetcher class42_sub1) +public static void nullLoader() +public static void unpackConfig(StreamLoader streamLoader) +public boolean isModelReady(int i) +public Model getModel(int i, int j, int k, int l, int i1, int j1, int k1) +public boolean areModelsReady() +public ObjectDef getChildDefinition() +public static MRUCache mruNodes2 = new MRUCache(30); +public static MRUCache mruNodes1 = new MRUCache(500); +``` diff --git a/docs/Client/classes/ObjectManager.md b/docs/Client/classes/ObjectManager.md index a121c8f90..1183358c0 100644 --- a/docs/Client/classes/ObjectManager.md +++ b/docs/Client/classes/ObjectManager.md @@ -1 +1,20 @@ # ObjectManager + +Defined in [`2006Scape Client/src/main/java/ObjectManager.java`](2006Scape Client/src/main/java/ObjectManager.java). + +Object Manager helper class. + +```java +final class ObjectManager { +public ObjectManager(byte abyte0[][][], int ai[][][]) +public final void buildLandscape(CollisionMap collisionMaps[], WorldController worldController) +public static void loadObjectModels(Stream stream, OnDemandFetcher onDemandFetcher) +public final void clearRegion(int i, int j, int l, int i1) +public static boolean isObjectVisible(int i, int j) +public final void loadChunk(int i, int j, CollisionMap collisionMaps[], int l, int i1, byte abyte0[], int j1, int k1, int l1) +public final void loadRegion(byte abyte0[], int i, int j, int k, int l, CollisionMap collisionMaps[]) +public final void loadObjectChunk(CollisionMap collisionMaps[], WorldController worldController, int i, int j, int k, int l, byte abyte0[], int i1, int j1, int k1) +public static void addObject(WorldController worldController, int i, int j, int k, int l, CollisionMap collisionMap, int ai[][][], int i1, int j1, int k1) +public static boolean areObjectsReady(int i, byte[] is, int i_250_) // xxx bad +public final void loadObjects(int i, CollisionMap collisionMaps[], int j, WorldController worldController, byte abyte0[]) +``` diff --git a/docs/Client/classes/OnDemandData.md b/docs/Client/classes/OnDemandData.md index 07b523d7a..6d21fb356 100644 --- a/docs/Client/classes/OnDemandData.md +++ b/docs/Client/classes/OnDemandData.md @@ -1 +1,10 @@ # OnDemandData + +Defined in [`2006Scape Client/src/main/java/OnDemandData.java`](2006Scape Client/src/main/java/OnDemandData.java). + +On Demand Data helper class. + +```java +public final class OnDemandData extends NodeSub { +public OnDemandData() +``` diff --git a/docs/Client/classes/OnDemandFetcher.md b/docs/Client/classes/OnDemandFetcher.md index dcdbf7b8e..275a991bb 100644 --- a/docs/Client/classes/OnDemandFetcher.md +++ b/docs/Client/classes/OnDemandFetcher.md @@ -1 +1,27 @@ # OnDemandFetcher + +Defined in [`2006Scape Client/src/main/java/OnDemandFetcher.java`](2006Scape Client/src/main/java/OnDemandFetcher.java). + +On Demand Fetcher helper class. + +```java +public final class OnDemandFetcher extends OnDemandFetcherParent implements Runnable { +public void start(StreamLoader streamLoader, Game client1) +public int getNodeCount() +public void disable() +public void requestMapFiles(boolean flag) +public int getVersionCount(int j) +public int getAnimCount() +public void queueRequest(int i, int j) +public int getModelIndex(int i) +public void run() +public void requestFileNow(int i, int j) +public OnDemandData getNextNode() +public int getRegionArchiveId(int type, int regionX, int regionY) +public void requestModel(int modelId) +public void validateOrQueue(byte byte0, int i, int j) +public boolean hasLandscape(int i) +public void clearPriorityQueue() +public boolean isMidiRequired(int i) +public OnDemandFetcher() +``` diff --git a/docs/Client/classes/OnDemandFetcherParent.md b/docs/Client/classes/OnDemandFetcherParent.md index 99c2f9fbe..7e5240e41 100644 --- a/docs/Client/classes/OnDemandFetcherParent.md +++ b/docs/Client/classes/OnDemandFetcherParent.md @@ -1 +1,10 @@ # OnDemandFetcherParent + +Defined in [`2006Scape Client/src/main/java/OnDemandFetcherParent.java`](2006Scape Client/src/main/java/OnDemandFetcherParent.java). + +On Demand Fetcher Parent helper class. + +```java +public class OnDemandFetcherParent { +public void requestModel(int i) +``` diff --git a/docs/Client/classes/PendingSpawn.md b/docs/Client/classes/PendingSpawn.md index 84de6682d..5822f26d3 100644 --- a/docs/Client/classes/PendingSpawn.md +++ b/docs/Client/classes/PendingSpawn.md @@ -1 +1,9 @@ # PendingSpawn + +Defined in [`2006Scape Client/src/main/java/PendingSpawn.java`](2006Scape Client/src/main/java/PendingSpawn.java). + +Pending Spawn helper class. + +```java +final class PendingSpawn extends Node { +``` diff --git a/docs/Client/classes/PlainTile.md b/docs/Client/classes/PlainTile.md index 7b71796bd..b8143d3de 100644 --- a/docs/Client/classes/PlainTile.md +++ b/docs/Client/classes/PlainTile.md @@ -1 +1,9 @@ # PlainTile + +Defined in [`2006Scape Client/src/main/java/PlainTile.java`](2006Scape Client/src/main/java/PlainTile.java). + +Plain Tile helper class. + +```java +final class PlainTile { +``` diff --git a/docs/Client/classes/Player.md b/docs/Client/classes/Player.md index eeff9286f..3219ae2fe 100644 --- a/docs/Client/classes/Player.md +++ b/docs/Client/classes/Player.md @@ -1 +1,13 @@ # Player + +Defined in [`2006Scape Client/src/main/java/Player.java`](2006Scape Client/src/main/java/Player.java). + +Player helper class. + +```java +public final class Player extends Entity { +public Model getRotatedModel() +public void updatePlayer(Stream stream) +public boolean isVisible() +public Model getDialogueModel() +``` diff --git a/docs/Client/classes/Projectile.md b/docs/Client/classes/Projectile.md index 5b857c52c..09660ec6b 100644 --- a/docs/Client/classes/Projectile.md +++ b/docs/Client/classes/Projectile.md @@ -1 +1,13 @@ # Projectile + +Defined in [`2006Scape Client/src/main/java/Projectile.java`](2006Scape Client/src/main/java/Projectile.java). + +Projectile helper class. + +```java +final class Projectile extends Animable { +public void track(int currentCycle, int targetY, int targetZ, int targetX) +public Model getRotatedModel() +public Projectile(int i, int j, int l, int i1, int j1, int k1, int l1, int i2, int j2, int k2, int l2) +public void update(int elapsed) +``` diff --git a/docs/Client/classes/QueuedMidiPlayer.md b/docs/Client/classes/QueuedMidiPlayer.md index acb8915fa..5eaa7a23d 100644 --- a/docs/Client/classes/QueuedMidiPlayer.md +++ b/docs/Client/classes/QueuedMidiPlayer.md @@ -1 +1,10 @@ # QueuedMidiPlayer + +Defined in [`2006Scape Client/src/main/java/QueuedMidiPlayer.java`](2006Scape Client/src/main/java/QueuedMidiPlayer.java). + +Queued Midi Player helper class. + +```java +final class QueuedMidiPlayer extends AbstractMidiController implements Runnable +public final void run() +``` diff --git a/docs/Client/classes/RSApplet.md b/docs/Client/classes/RSApplet.md index 3f8fa19d5..b73869fa9 100644 --- a/docs/Client/classes/RSApplet.md +++ b/docs/Client/classes/RSApplet.md @@ -1 +1,51 @@ # RSApplet + +Defined in [`2006Scape Client/src/main/java/RSApplet.java`](2006Scape Client/src/main/java/RSApplet.java). + +RSApplet helper class. + +```java +public class RSApplet extends Applet implements Runnable, MouseListener, MouseWheelListener, MouseMotionListener, KeyListener, FocusListener, WindowListener { +public void mouseClicked(MouseEvent e) +public void mouseEntered(MouseEvent e) +public void mouseExited(MouseEvent e) +public void mouseClicked(MouseEvent e) +public void mouseEntered(MouseEvent e) +public void mouseExited(MouseEvent e) +public void mouseClicked(MouseEvent e) +public void mouseEntered(MouseEvent e) +public void mouseExited(MouseEvent e) +public void mouseClicked(MouseEvent e) +public void mouseEntered(MouseEvent e) +public void mouseExited(MouseEvent e) +public void mouseClicked(MouseEvent e) +public void mouseEntered(MouseEvent e) +public void mouseExited(MouseEvent e) +public void run() +public final void start() +public final void stop() +public final void destroy() +public final void update(Graphics g) +public final void paint(Graphics g) +public final void mousePressed(MouseEvent mouseevent) +public final void mouseReleased(MouseEvent mouseevent) +public final void mouseClicked(MouseEvent mouseevent) +public final void mouseEntered(MouseEvent mouseevent) +public final void mouseExited(MouseEvent mouseevent) +public final void mouseDragged(MouseEvent e) +public void mouseMoved(MouseEvent mouseevent) +public void mouseWheelMoved(MouseWheelEvent e) {} +public void keyPressed(KeyEvent keyevent) +public final void keyReleased(KeyEvent keyevent) +public final void keyTyped(KeyEvent keyevent) +public final void focusGained(FocusEvent focusevent) +public final void focusLost(FocusEvent focusevent) +public final void windowActivated(WindowEvent windowevent) +public final void windowClosed(WindowEvent windowevent) +public final void windowClosing(WindowEvent windowevent) +public final void windowDeactivated(WindowEvent windowevent) +public final void windowDeiconified(WindowEvent windowevent) +public final void windowIconified(WindowEvent windowevent) +public final void windowOpened(WindowEvent windowevent) +public void startRunnable(Runnable runnable, int priority) +``` diff --git a/docs/Client/classes/RSFrame.md b/docs/Client/classes/RSFrame.md index 64c5aace5..164cf01b3 100644 --- a/docs/Client/classes/RSFrame.md +++ b/docs/Client/classes/RSFrame.md @@ -1 +1,10 @@ # RSFrame + +Defined in [`2006Scape Client/src/main/java/RSFrame.java`](2006Scape Client/src/main/java/RSFrame.java). + +RSFrame helper class. + +```java +final class RSFrame extends Frame { +public RSFrame(RSApplet applet) +``` diff --git a/docs/Client/classes/RSImageProducer.md b/docs/Client/classes/RSImageProducer.md index 190c0bfa8..4934c431d 100644 --- a/docs/Client/classes/RSImageProducer.md +++ b/docs/Client/classes/RSImageProducer.md @@ -1 +1,18 @@ # RSImageProducer + +Defined in [`2006Scape Client/src/main/java/RSImageProducer.java`](2006Scape Client/src/main/java/RSImageProducer.java). + +RSImage Producer helper class. + +```java +final class RSImageProducer implements ImageProducer, ImageObserver { +public RSImageProducer(int width, int height, Component component) +public void initDrawingArea() +public void drawGraphics(int i, Graphics g, int k) +public synchronized void addConsumer(ImageConsumer imageconsumer) +public synchronized boolean isConsumer(ImageConsumer imageconsumer) +public synchronized void removeConsumer(ImageConsumer imageconsumer) +public void startProduction(ImageConsumer imageconsumer) +public void requestTopDownLeftRightResend(ImageConsumer imageconsumer) +public boolean imageUpdate(Image image, int i, int j, int k, int l, int i1) +``` diff --git a/docs/Client/classes/RSInterface.md b/docs/Client/classes/RSInterface.md index 1cd88293c..8dba2e6be 100644 --- a/docs/Client/classes/RSInterface.md +++ b/docs/Client/classes/RSInterface.md @@ -1 +1,15 @@ # RSInterface + +Defined in [`2006Scape Client/src/main/java/RSInterface.java`](2006Scape Client/src/main/java/RSInterface.java). + +RSInterface helper class. + +```java +public final class RSInterface { +public void swapInventoryItems(int i, int j) +public static void unpack(StreamLoader streamLoader, TextDrawingArea textDrawingAreas[], StreamLoader streamLoader_1) +public static void discardInterface(int i) +public static void clearModelCache(Model model, int id, int type) +public Model prepareModel(int j, int k, boolean flag) +public RSInterface() +``` diff --git a/docs/Client/classes/RSSocket.md b/docs/Client/classes/RSSocket.md index 60e7f8c02..2b108d9b4 100644 --- a/docs/Client/classes/RSSocket.md +++ b/docs/Client/classes/RSSocket.md @@ -1 +1,17 @@ # RSSocket + +Defined in [`2006Scape Client/src/main/java/RSSocket.java`](2006Scape Client/src/main/java/RSSocket.java). + +RSSocket helper class. + +```java +final class RSSocket implements Runnable { +public RSSocket(RSApplet RSApplet_, Socket socket1) throws IOException +public void close() +public int read() throws IOException +public int available() throws IOException +public void flushInputStream(byte abyte0[], int j) throws IOException +public void queueBytes(int i, byte abyte0[]) throws IOException +public void run() +public void printDebug() +``` diff --git a/docs/Client/classes/SceneObject.md b/docs/Client/classes/SceneObject.md index 421a309e0..b41124161 100644 --- a/docs/Client/classes/SceneObject.md +++ b/docs/Client/classes/SceneObject.md @@ -1 +1,10 @@ # SceneObject + +Defined in [`2006Scape Client/src/main/java/SceneObject.java`](2006Scape Client/src/main/java/SceneObject.java). + +Scene Object helper class. + +```java +public final class SceneObject { +public SceneObject() +``` diff --git a/docs/Client/classes/ShapedTile.md b/docs/Client/classes/ShapedTile.md index 4f219d454..15e313696 100644 --- a/docs/Client/classes/ShapedTile.md +++ b/docs/Client/classes/ShapedTile.md @@ -1 +1,10 @@ # ShapedTile + +Defined in [`2006Scape Client/src/main/java/ShapedTile.java`](2006Scape Client/src/main/java/ShapedTile.java). + +Shaped Tile helper class. + +```java +final class ShapedTile { +public ShapedTile(int i, int j, int k, int l, int i1, int j1, int k1, int l1, int i2, int j2, int k2, int l2, int i3, int j3, int k3, int l3, int i4, int k4, int l4) +``` diff --git a/docs/Client/classes/Signlink.md b/docs/Client/classes/Signlink.md index de79492e5..5625eea50 100644 --- a/docs/Client/classes/Signlink.md +++ b/docs/Client/classes/Signlink.md @@ -1 +1,24 @@ # Signlink + +Defined in [`2006Scape Client/src/main/java/Signlink.java`](2006Scape Client/src/main/java/Signlink.java). + +Signlink helper class. + +```java +public final class Signlink implements Runnable { +public static final void startpriv(InetAddress inetaddress) +public void run() +public static boolean setVolume(int value) +public static void fadeOut() +public static String findcachedir() +public static String secondDir() +public static synchronized Socket opensocket(int i) throws IOException +public static synchronized DataInputStream openurl(String s) throws IOException +public static synchronized void dnslookup(String s) +public static synchronized void startthread(Runnable runnable, int i) +public static synchronized boolean wavesave(byte abyte0[], int i) +public static synchronized boolean wavereplay() +public static synchronized void saveMidi(byte abyte0[], int i) +public static void reporterror(String s) +public static Midi midii = new Midi(); +``` diff --git a/docs/Client/classes/SizeConstants.md b/docs/Client/classes/SizeConstants.md index 09b01143f..896fa7d16 100644 --- a/docs/Client/classes/SizeConstants.md +++ b/docs/Client/classes/SizeConstants.md @@ -1 +1,9 @@ # SizeConstants + +Defined in [`2006Scape Client/src/main/java/SizeConstants.java`](2006Scape Client/src/main/java/SizeConstants.java). + +Static constants used by size. + +```java +final class SizeConstants { +``` diff --git a/docs/Client/classes/Skills.md b/docs/Client/classes/Skills.md index f026f07ec..39b30560d 100644 --- a/docs/Client/classes/Skills.md +++ b/docs/Client/classes/Skills.md @@ -1 +1,9 @@ # Skills + +Defined in [`2006Scape Client/src/main/java/Skills.java`](2006Scape Client/src/main/java/Skills.java). + +Skills helper class. + +```java +final class Skills { +``` diff --git a/docs/Client/classes/SoundEnvelope.md b/docs/Client/classes/SoundEnvelope.md index 3b5056fdf..108e7621e 100644 --- a/docs/Client/classes/SoundEnvelope.md +++ b/docs/Client/classes/SoundEnvelope.md @@ -1 +1,12 @@ # SoundEnvelope + +Defined in [`2006Scape Client/src/main/java/SoundEnvelope.java`](2006Scape Client/src/main/java/SoundEnvelope.java). + +Sound Envelope helper class. + +```java +final class SoundEnvelope { +public void decode(Stream stream) +public void decodeSegments(Stream stream) +public SoundEnvelope() +``` diff --git a/docs/Client/classes/SoundFilter.md b/docs/Client/classes/SoundFilter.md index b0d8c44d6..ad6c3b2f1 100644 --- a/docs/Client/classes/SoundFilter.md +++ b/docs/Client/classes/SoundFilter.md @@ -1 +1,12 @@ # SoundFilter + +Defined in [`2006Scape Client/src/main/java/SoundFilter.java`](2006Scape Client/src/main/java/SoundFilter.java). + +Sound Filter helper class. + +```java +final class SoundFilter { +public int compute(int channel, float f) +public void decode(Stream stream, SoundEnvelope envelope) +public SoundFilter() +``` diff --git a/docs/Client/classes/SoundPlayer.md b/docs/Client/classes/SoundPlayer.md index 9ad0bde71..f3805a389 100644 --- a/docs/Client/classes/SoundPlayer.md +++ b/docs/Client/classes/SoundPlayer.md @@ -1 +1,14 @@ # SoundPlayer + +Defined in [`2006Scape Client/src/main/java/SoundPlayer.java`](2006Scape Client/src/main/java/SoundPlayer.java). + +Sound Player helper class. + +```java +public class SoundPlayer implements Runnable { +public SoundPlayer(InputStream stream, int level, int delay) +public void run() +public static void setVolume(int level) +public static int getVolume() +public float getDecibels(int level) +``` diff --git a/docs/Client/classes/Sounds.md b/docs/Client/classes/Sounds.md index d5f373a77..8d2b910ca 100644 --- a/docs/Client/classes/Sounds.md +++ b/docs/Client/classes/Sounds.md @@ -1 +1,11 @@ # Sounds + +Defined in [`2006Scape Client/src/main/java/Sounds.java`](2006Scape Client/src/main/java/Sounds.java). + +Sounds helper class. + +```java +final class Sounds { +public static void unpack(Stream stream) +public static Stream createSoundStream(int loops, int id) +``` diff --git a/docs/Client/classes/SpotAnim.md b/docs/Client/classes/SpotAnim.md index c73c5c70e..01f755191 100644 --- a/docs/Client/classes/SpotAnim.md +++ b/docs/Client/classes/SpotAnim.md @@ -1 +1,12 @@ # SpotAnim + +Defined in [`2006Scape Client/src/main/java/SpotAnim.java`](2006Scape Client/src/main/java/SpotAnim.java). + +Spot Anim helper class. + +```java +public final class SpotAnim { +public static void unpackConfig(StreamLoader streamLoader) +public Model getModel() +public static MRUCache modelCache = new MRUCache(30); +``` diff --git a/docs/Client/classes/Sprite.md b/docs/Client/classes/Sprite.md index 2a6a76952..4daaf0b79 100644 --- a/docs/Client/classes/Sprite.md +++ b/docs/Client/classes/Sprite.md @@ -1 +1,21 @@ # Sprite + +Defined in [`2006Scape Client/src/main/java/Sprite.java`](2006Scape Client/src/main/java/Sprite.java). + +Sprite helper class. + +```java +public final class Sprite extends DrawingArea { +public Sprite(int i, int j) +public Sprite(byte abyte0[], Component component) +public Sprite(StreamLoader streamLoader, String s, int i) +public void initializeDrawingArea() +public void adjustRgb(int redOffset, int greenOffset, int blueOffset) +public void crop() +public void drawSprite(int x, int y) +public void drawSprite1(int i, int j) +public void drawTransparentSprite(int i, int k) +public void drawTransformed(int i, int j, int ai[], int k, int ai1[], int i1, int j1, int k1, int l1, int i2) +public void drawRotated(int i, double d, int l1) +public void drawWithMask(Background background, int i, int j) +``` diff --git a/docs/Client/classes/Stream.md b/docs/Client/classes/Stream.md index 867bd88c3..4052abba5 100644 --- a/docs/Client/classes/Stream.md +++ b/docs/Client/classes/Stream.md @@ -1 +1,58 @@ # Stream + +Defined in [`2006Scape Client/src/main/java/Stream.java`](2006Scape Client/src/main/java/Stream.java). + +Stream helper class. + +```java +public final class Stream extends NodeSub { +public static Stream create() +public int readUnsignedByteAdd() +public Stream(byte abyte0[]) +public void createFrame(int i) +public void writeWordBigEndian(int i) +public void writeWord(int i) +public void writeShortLE(int i) +public void writeDWordBigEndian(int i) +public void writeDWord(int i) +public void writeIntLE(int value) +public void writeQWord(long l) +public void writeString(String s) +public void writeBytes(byte abyte0[], int i, int j) +public void writeBytes(int i) +public int readUnsignedByte() +public byte readSignedByte() +public int readUnsignedWord() +public int readSignedWord() +public int read3Bytes() +public int readDWord() +public long readQWord() +public String readString() +public byte[] readBytes() +public void readBytes(int i, int j, byte abyte0[]) +public void initBitAccess() +public int readBits(int i) +public void finishBitAccess() +public int readSignedSmart() +public int readUnsignedSmart() +public void rsaEncrypt() +public void writeByteNeg(int value) +public void writeByteSub(int value) +public int readUnsignedByteA() +public int readUnsignedByteNeg() +public int readUnsignedByteSub() +public byte readByteNeg() +public byte readByteSub() +public void writeShortLEDup(int value) +public void writeShortA(int value) +public void writeShortLEA(int value) +public int readShortLE() +public int readShortAdd() +public int readShortLEAdd() +public int readShortLESigned() +public int readShortLEAddSigned() +public int readIntV1() +public int readIntV2() +public void writeBytesReverseAdd(int length, byte[] data, int offset) +public void readBytesReverse(int length, int offset, byte[] data) +``` diff --git a/docs/Client/classes/StreamLoader.md b/docs/Client/classes/StreamLoader.md index f22bdbede..256632677 100644 --- a/docs/Client/classes/StreamLoader.md +++ b/docs/Client/classes/StreamLoader.md @@ -1 +1,11 @@ # StreamLoader + +Defined in [`2006Scape Client/src/main/java/StreamLoader.java`](2006Scape Client/src/main/java/StreamLoader.java). + +Stream Loader helper class. + +```java +final class StreamLoader { +public StreamLoader(byte archiveData[]) +public byte[] getFileData(String s) +``` diff --git a/docs/Client/classes/SystemMidiPlayer.md b/docs/Client/classes/SystemMidiPlayer.md index 3b9931493..a5a61da8d 100644 --- a/docs/Client/classes/SystemMidiPlayer.md +++ b/docs/Client/classes/SystemMidiPlayer.md @@ -1 +1,11 @@ # SystemMidiPlayer + +Defined in [`2006Scape Client/src/main/java/SystemMidiPlayer.java`](2006Scape Client/src/main/java/SystemMidiPlayer.java). + +System Midi Player helper class. + +```java +final class SystemMidiPlayer extends AbstractMidiController implements Receiver +public final synchronized void send(MidiMessage midimessage, long l) +public final void close() +``` diff --git a/docs/Client/classes/TextClass.md b/docs/Client/classes/TextClass.md index e89cd1e55..0c36b97c5 100644 --- a/docs/Client/classes/TextClass.md +++ b/docs/Client/classes/TextClass.md @@ -1 +1,15 @@ # TextClass + +Defined in [`2006Scape Client/src/main/java/TextClass.java`](2006Scape Client/src/main/java/TextClass.java). + +Text Class helper class. + +```java +final class TextClass { +public static long longForName(String s) +public static String nameForLong(long l) +public static long hashSpriteName(String s) +public static String intToIpString(int i) +public static String fixName(String s) +public static String passwordAsterisks(String s) +``` diff --git a/docs/Client/classes/TextDrawingArea.md b/docs/Client/classes/TextDrawingArea.md index c040f4a4a..6316f9a02 100644 --- a/docs/Client/classes/TextDrawingArea.md +++ b/docs/Client/classes/TextDrawingArea.md @@ -1 +1,22 @@ # TextDrawingArea + +Defined in [`2006Scape Client/src/main/java/TextDrawingArea.java`](2006Scape Client/src/main/java/TextDrawingArea.java). + +Text Drawing Area helper class. + +```java +public final class TextDrawingArea extends DrawingArea { +public TextDrawingArea(boolean flag, String s, StreamLoader streamLoader) +public void textRight(int i, String s, int k, int l) +public void textCenter(int i, String s, int k, int l) +public void textCenterShadow(int _color, int _x, String s, int _y, boolean _shadow) +public void textRightShadow(boolean _shadow, int _x, int _color, String s, int _y) +public int getTextWidth(String s) +public int measurePlainTextWidth(String s) +public void textLeft(int i, String s, int j, int l) +public void drawWavyCenteredText(int i, String s, int j, int k, int l) +public void drawWavyText(int i, String s, int j, int k, int l) +public void drawShakeText(int i, String s, int j, int k, int l, int i1) +public void textLeftShadow(boolean _shadow, int _x, int _color, String s, int _y) +public void drawRandomColorText(int i, int j, String s, int k, int i1) +``` diff --git a/docs/Client/classes/TextInput.md b/docs/Client/classes/TextInput.md index c55ce3dde..32d99f562 100644 --- a/docs/Client/classes/TextInput.md +++ b/docs/Client/classes/TextInput.md @@ -1 +1,12 @@ # TextInput + +Defined in [`2006Scape Client/src/main/java/TextInput.java`](2006Scape Client/src/main/java/TextInput.java). + +Text Input helper class. + +```java +final class TextInput { +public static String decodeChatMessage(int i, Stream stream) +public static void encodeChatMessage(String s, Stream stream) +public static String processText(String s) +``` diff --git a/docs/Client/classes/Texture.md b/docs/Client/classes/Texture.md index d4ad03657..9f6bd8fb7 100644 --- a/docs/Client/classes/Texture.md +++ b/docs/Client/classes/Texture.md @@ -1 +1,21 @@ # Texture + +Defined in [`2006Scape Client/src/main/java/Texture.java`](2006Scape Client/src/main/java/Texture.java). + +Texture helper class. + +```java +final class Texture extends DrawingArea { +public static void reset() +public static void init() +public static void resize(int j, int k) +public static void clearCache() +public static void initCache() +public static void loadTextures(StreamLoader streamLoader) +public static int getAverageTextureColor(int i) +public static void unloadTexture(int i) +public static void setBrightness(double d) +public static void drawGouraudTriangle(int i, int j, int k, int l, int i1, int j1, int k1, int l1, int i2) +public static void drawFlatTriangle(int i, int j, int k, int l, int i1, int j1, int k1) +public static void drawTexturedTriangle(int i, int j, int k, int l, int i1, int j1, int k1, int l1, int i2, int j2, int k2, int l2, int i3, int j3, int k3, int l3, int i4, int j4, int k4) +``` diff --git a/docs/Client/classes/TileDecoration.md b/docs/Client/classes/TileDecoration.md index a44ef1fd3..4158b762a 100644 --- a/docs/Client/classes/TileDecoration.md +++ b/docs/Client/classes/TileDecoration.md @@ -1 +1,10 @@ # TileDecoration + +Defined in [`2006Scape Client/src/main/java/TileDecoration.java`](2006Scape Client/src/main/java/TileDecoration.java). + +Tile Decoration helper class. + +```java +public final class TileDecoration { +public TileDecoration() {} +``` diff --git a/docs/Client/classes/TileRotation.md b/docs/Client/classes/TileRotation.md index bedbf1177..a0fabd564 100644 --- a/docs/Client/classes/TileRotation.md +++ b/docs/Client/classes/TileRotation.md @@ -1 +1,13 @@ # TileRotation + +Defined in [`2006Scape Client/src/main/java/TileRotation.java`](2006Scape Client/src/main/java/TileRotation.java). + +Tile Rotation helper class. + +```java +final class TileRotation { +public static int rotateX(int i, int j, int k) +public static int rotateY(int i, int j, int l) +public static int rotateWidth(int i, int j, int k, int l, int i1) +public static int rotateHeight(int j, int k, int l, int i1, int j1) +``` diff --git a/docs/Client/classes/VarBit.md b/docs/Client/classes/VarBit.md index 026a8224b..07ef469a1 100644 --- a/docs/Client/classes/VarBit.md +++ b/docs/Client/classes/VarBit.md @@ -1 +1,10 @@ # VarBit + +Defined in [`2006Scape Client/src/main/java/VarBit.java`](2006Scape Client/src/main/java/VarBit.java). + +Var Bit helper class. + +```java +public final class VarBit { +public static void unpackConfig(StreamLoader streamLoader) +``` diff --git a/docs/Client/classes/Varp.md b/docs/Client/classes/Varp.md index abe9accba..970a2feaa 100644 --- a/docs/Client/classes/Varp.md +++ b/docs/Client/classes/Varp.md @@ -1 +1,10 @@ # Varp + +Defined in [`2006Scape Client/src/main/java/Varp.java`](2006Scape Client/src/main/java/Varp.java). + +Varp helper class. + +```java +public final class Varp { +public static void unpackConfig(StreamLoader streamLoader) +``` diff --git a/docs/Client/classes/VertexNormal.md b/docs/Client/classes/VertexNormal.md index fb636627c..0676f5834 100644 --- a/docs/Client/classes/VertexNormal.md +++ b/docs/Client/classes/VertexNormal.md @@ -1 +1,10 @@ # VertexNormal + +Defined in [`2006Scape Client/src/main/java/VertexNormal.java`](2006Scape Client/src/main/java/VertexNormal.java). + +Vertex Normal helper class. + +```java +final class VertexNormal { +public VertexNormal() {} +``` diff --git a/docs/Client/classes/WallDecoration.md b/docs/Client/classes/WallDecoration.md index 81f2d2992..0da6664d9 100644 --- a/docs/Client/classes/WallDecoration.md +++ b/docs/Client/classes/WallDecoration.md @@ -1 +1,10 @@ # WallDecoration + +Defined in [`2006Scape Client/src/main/java/WallDecoration.java`](2006Scape Client/src/main/java/WallDecoration.java). + +Wall Decoration helper class. + +```java +public final class WallDecoration { +public WallDecoration() +``` diff --git a/docs/Client/classes/WorldController.md b/docs/Client/classes/WorldController.md index f2653790e..a749f8844 100644 --- a/docs/Client/classes/WorldController.md +++ b/docs/Client/classes/WorldController.md @@ -1 +1,45 @@ # WorldController + +Defined in [`2006Scape Client/src/main/java/WorldController.java`](2006Scape Client/src/main/java/WorldController.java). + +World Controller helper class. + +```java +final class WorldController { +public WorldController(int[][][] heights) +public static void nullLoader() +public void initToNull() +public void setActivePlane(int i) +public void shiftDownPlanes(int i, int j) +public static void addCullingCluster(int i, int j, int k, int l, int i1, int j1, int l1, int i2) +public void setGroundFlag(int i, int j, int k, int l) +public void addTile(int i, int j, int k, int l, int i1, int j1, int k1, int l1, int i2, int j2, int k2, int l2, int i3, int j3, int k3, int l3, int i4, int j4, int k4, int l4) +public void addTileDecoration(int plane, int height, int tileY, Animable renderable, byte config, int uid, int tileX) +public void addItemPile(int i, int j, Animable renderable, int k, Animable secondaryRenderable, Animable topRenderable, int l, int i1) +public void addBoundaryObject(int i, Animable renderable, int j, int k, byte byte0, int l, Animable secondaryRenderable, int i1, int j1, int k1) +public void addWallDecoration(int i, int j, int k, int i1, int j1, int k1, Animable renderable, int l1, byte byte0, int i2, int j2) +public boolean addGameObject(int i, byte byte0, int j, int k, Animable renderable, int l, int i1, int j1, int k1, int l1) +public boolean addAnimableObject(int i, int j, int k, int l, int i1, int j1, int k1, Animable renderable, boolean flag) +public boolean addAnimatingObject(int j, int k, Animable renderable, int l, int i1, int j1, int k1, int l1, int i2, int j2, int k2) +public void clearObj5Cache() +public void updateWallDecorationPosition(int i, int k, int l, int i1) +public void clearBoundaryObject(int i, int j, int k, byte byte0) +public void clearWallDecoration(int j, int k, int l) +public void removeSceneObject(int i, int k, int l) +public void clearTileDecoration(int i, int j, int k) +public void clearItemPile(int i, int j, int k) +public BoundaryObject getBoundaryObject(int i, int j, int k) +public WallDecoration getWallDecoration(int i, int k, int l) +public SceneObject getSceneObject(int i, int j, int k) +public TileDecoration getTileDecoration(int i, int j, int k) +public int getBoundaryObjectUid(int i, int j, int k) +public int getWallDecorationUid(int i, int j, int l) +public int getSceneObjectUid(int i, int j, int k) +public int getTileDecorationUid(int i, int j, int k) +public int getObjectConfig(int i, int j, int k, int l) +public void applySceneLighting(int i, int k, int i1) +public void renderMinimapTile(int ai[], int i, int k, int l, int i1) +public static void buildVisibilityMap(int i, int j, int k, int l, int ai[]) +public void queueClick(int i, int j) +public void renderScene(int i, int j, int k, int l, int i1, int j1) +``` diff --git a/docs/Server/classes/Agility.md b/docs/Server/classes/Agility.md index 82cfce1b9..2fce63d2e 100644 --- a/docs/Server/classes/Agility.md +++ b/docs/Server/classes/Agility.md @@ -10,7 +10,35 @@ Gameplay logic related to the Agility skill. public class Agility { public Agility(Player player) public void resetAgilityProgress() -private void walkToEmote(int id) -private void stopEmote() -private static void setAnimationBack(Player player) +public void walk(int EndX, int EndY, int Emote, int endingAnimation) +public static void brimhavenSkippingStone(final Player player) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void destinationReached(int x2, int y2, final int endingEmote) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public double getXp(int objectId) +public int getAnimation(int objectId) +public void climbUpTropicalTree(final int moveX, final int moveY, final int moveH) +public void execute(CycleEventContainer container) +public void stop() +public void climbUp(final int moveX, final int moveY, final int moveH) +public void execute(CycleEventContainer container) +public void stop() +public void climbDown(final int moveX, final int moveY, final int moveH) +public void execute(CycleEventContainer container) +public void stop() +public boolean hotSpot(int hotX, int hotY) +public void lapFinished() +public void agilityProcess() +public boolean checkLevel(int objectId) +public static void Brimhavenprocess() ``` diff --git a/docs/Server/classes/AgilityShortcut.md b/docs/Server/classes/AgilityShortcut.md index 0f51e500f..999af3427 100644 --- a/docs/Server/classes/AgilityShortcut.md +++ b/docs/Server/classes/AgilityShortcut.md @@ -8,6 +8,5 @@ Agility Shortcuts @author Andrew (Mr Extremez) ```java public class AgilityShortcut { -private static void handleAgility(Player player, int x, int y, int levelReq, int anim, int walk, String message) public static void processAgilityShortcut(Player player) ``` diff --git a/docs/Server/classes/Alchemy.md b/docs/Server/classes/Alchemy.md index deae50f29..9f5f8d5fc 100644 --- a/docs/Server/classes/Alchemy.md +++ b/docs/Server/classes/Alchemy.md @@ -13,4 +13,6 @@ public void searchCupboard(int objectID) public void alchItem(int itemID, int spellID) public void collectCoins() public void clearItems() +public static void process() +public static void updateInterface(Player player) ``` diff --git a/docs/Server/classes/Allotments.md b/docs/Server/classes/Allotments.md index 43c35d30a..8486bc4bb 100644 --- a/docs/Server/classes/Allotments.md +++ b/docs/Server/classes/Allotments.md @@ -9,8 +9,54 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class Allotments { public Allotments(Player player) -private static Map seeds = new HashMap(); public static AllotmentData forId(int seedId) public int getSeedId() public int getHarvestId() +public int getFlowerProtect() +public int getSeedAmount() +public int getLevelRequired() +public int[] getPaymentToWatch() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public static AllotmentFieldsData forIdPosition(int x, int y) +public static ArrayList listIndexProtected(int npcId) +public int getAllotmentIndex() +public Point[] getAllotmentPosition() +public int getFarmerBelonging() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateAllotmentsStates() +public int getPlantState(int plantState) +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean waterPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeed(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvest(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public void handleFlowerProtection(int index) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/ApolloHandler.md b/docs/Server/classes/ApolloHandler.md index 72116b467..d9309f8b7 100644 --- a/docs/Server/classes/ApolloHandler.md +++ b/docs/Server/classes/ApolloHandler.md @@ -8,9 +8,10 @@ An implementation of {@link ChannelInboundHandlerAdapter} which handles incoming ```java public final class ApolloHandler extends ChannelInboundHandlerAdapter { -private static final Logger logger = Logger.getLogger(ApolloHandler.class.getName()); public static final AttributeKey SESSION_KEY = AttributeKey.valueOf("session"); public ApolloHandler() public void channelInactive(ChannelHandlerContext ctx) public void exceptionCaught(ChannelHandlerContext ctx, Throwable e) +public void channelRead(ChannelHandlerContext ctx, Object message) throws Exception +public void channelReadComplete(ChannelHandlerContext ctx) ``` diff --git a/docs/Server/classes/ArrowMaking.md b/docs/Server/classes/ArrowMaking.md index a3715b916..84bd7d323 100644 --- a/docs/Server/classes/ArrowMaking.md +++ b/docs/Server/classes/ArrowMaking.md @@ -9,8 +9,12 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/fletchin ```java public class ArrowMaking { public static Data forId(int itemUsed, int usedWith) -private Data(int item1, int item2, int product, int level, double xp) public int getItem1() public int getItem2() public int getProduct() +public int getLevel() +public double getXp() +public static boolean makeArrow(final Player player, int itemUsed, int usedWith) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Balloons.md b/docs/Server/classes/Balloons.md index 79e0997bc..012ce3028 100644 --- a/docs/Server/classes/Balloons.md +++ b/docs/Server/classes/Balloons.md @@ -13,4 +13,8 @@ public static Balloons getBalloon(int x, int y, int height, int item, int amount public static Balloons getBalloon(int x, int y, int item, int amount) public static Balloons getEmpty(int x, int y, int height) public static Balloons getEmpty(int x, int y) +public void popBalloon(Player player) +public static int getRandomBalloon() +public int getPoppedBalloon() +public void remove() ``` diff --git a/docs/Server/classes/BankPin.md b/docs/Server/classes/BankPin.md index 69d510223..ad4d0ccfe 100644 --- a/docs/Server/classes/BankPin.md +++ b/docs/Server/classes/BankPin.md @@ -13,4 +13,9 @@ public int dateExpired() public int dateRequested() public void closeBankPin() public void pinSettingFrames() +public void bankPinSettings() +public boolean resetBankPin() +public void bankPinEnter(int button) +public void openPin() +public String toString() ``` diff --git a/docs/Server/classes/Barrows.md b/docs/Server/classes/Barrows.md index fc8267b89..a52a3522d 100644 --- a/docs/Server/classes/Barrows.md +++ b/docs/Server/classes/Barrows.md @@ -13,4 +13,11 @@ public int randomBarrows() public int randomRunes() public int randomPots() public void spadeDigging() +public void useStairs() +public void checkCoffins() +public void reward() +public boolean checkBarrows() +public void useChest() +public void fixAllBarrows() +public void resetBarrows() ``` diff --git a/docs/Server/classes/BattleStaffs.md b/docs/Server/classes/BattleStaffs.md index ad8a17f85..1bfea09c9 100644 --- a/docs/Server/classes/BattleStaffs.md +++ b/docs/Server/classes/BattleStaffs.md @@ -8,9 +8,11 @@ Battle Staff making @author Andrew (Mr Extremez) ```java public class BattleStaffs { -private battleStaffs(final int orb, final int levelReq, final int xpRecieved, final int battlestaff) public int getOrb() public int getLevelReq() public int getXP() public int getBattlestaff() +public static void makeBattleStaff(Player player, int itemUsed, int usedWith) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Beverages.md b/docs/Server/classes/Beverages.md index 1b1569364..bae65a16e 100644 --- a/docs/Server/classes/Beverages.md +++ b/docs/Server/classes/Beverages.md @@ -13,4 +13,11 @@ public int getRep() public int getAnim() public boolean getEffect1() public boolean getEffect2() +public boolean getEffect3() +public boolean getEffect4() +public static boolean isBeverage(Player c, int beverageId) +public void execute(CycleEventContainer container) +public void stop() +public static void foodEffect(Player c, int id) +public static void drinkBeverage(final Player player, final int beverageId, int slotId) ``` diff --git a/docs/Server/classes/Bot.md b/docs/Server/classes/Bot.md index 1b847de75..2c9ef1de4 100644 --- a/docs/Server/classes/Bot.md +++ b/docs/Server/classes/Bot.md @@ -13,4 +13,5 @@ public Client getBotClient() public void run() public void sendTradeChat() public static String formatSellPrice(int price) +public String generatePassword(int targetStringLength) ``` diff --git a/docs/Server/classes/BotHandler.md b/docs/Server/classes/BotHandler.md index 58ec16e53..3dffd9de9 100644 --- a/docs/Server/classes/BotHandler.md +++ b/docs/Server/classes/BotHandler.md @@ -11,6 +11,12 @@ public class BotHandler { public static Bot connectBot(String username, Integer x, Integer y, Integer z) public static void loadPlayerShops() public static void playerShop(Player player) -private static String getShopName(String playerName) -private static Client getPlayerShop(String playerName) +public static void closeShop(Player player) +public static void addCoins(int shop_id, int amount) +public static int checkCoins(Player player) +public static void takeCoins(Player player) +public static void addTobank(int shop_id, int item_id, int amount) +public static void removeFrombank(int shop_id, int item_id, int amount) +public static int getItemPrice(int shop_id, int item_id) +public static void setPrice(int shop_id, int item_id, int amount) ``` diff --git a/docs/Server/classes/Boundary.md b/docs/Server/classes/Boundary.md index 492999e25..f9f0b0504 100644 --- a/docs/Server/classes/Boundary.md +++ b/docs/Server/classes/Boundary.md @@ -13,4 +13,67 @@ public Boundary(int minX, int highX, int minY, int highY, int height) public static boolean isIn(Player player, Boundary[] boundaries) public static boolean isIn(Player player, Boundary boundaries) public static boolean isIn(int x, int y, Boundary boundaries) +public static boolean isIn(int x, int y, int h, Boundary boundaries) +public static boolean isIn(Npc npc, Boundary boundaries) +public static boolean isIn(Npc npc, Boundary[] boundaries) +public static boolean isInSameBoundary(Player player1, Player player2, Boundary[] boundaries) +public static int entitiesInArea(Boundary boundary) +public static Coordinate centre(Boundary boundary) +public static final Boundary F2P = new Boundary(2944, 3328, 3097, 3515); +public static final Boundary TUTORIAL = new Boundary(3055, 3150, 3054, 3128); +public static final Boundary CRANDOR = new Boundary(2813, 2867, 3226, 3307); +public static final Boundary LUMBRIDGE = new Boundary(3134, 3266, 3131, 3317); +public static final Boundary WIZARDS_TOWER = new Boundary(3094, 3124, 3141, 3172); +public static final Boundary FALADOR = new Boundary(2945, 3066, 3303, 3390); +public static final Boundary VARROCK = new Boundary(3172, 3289, 3368, 3504); +public static final Boundary DRAYNOR = new Boundary(3079, 3149, 3226, 3382); +public static final Boundary BARB = new Boundary(3072, 3098, 3399, 3445); +public static final Boundary GOBLIN_VILLAGE = new Boundary(2945, 2970, 3475, 3515); +public static final Boundary EDGEVILLE = new Boundary(3072, 3126, 3459, 3517); +public static final Boundary PORT_SARIM = new Boundary(3327, 3423, 3131, 3324); +public static final Boundary RIMMINGTON = new Boundary(3327, 3423, 3131, 3324); +public static final Boundary AL_KHARID = new Boundary(3327, 3423, 3131, 3324); +public static final Boundary ZAMMY_WAIT = new Boundary(2409, 2431, 9511, 9535); +public static final Boundary SARA_WAIT = new Boundary(2368, 2392, 9479, 9498); +public static final Boundary BRIMHAVEN = new Boundary(2688, 2815, 3131, 3258); +public static final Boundary DESERT = new Boundary(3137, 3517, 2747, 3130, 0); +public static final Boundary NARDAH = new Boundary(3392, 3455, 2876, 2940); +public static final Boundary BANDIT_CAMP = new Boundary(3151, 3192, 2963, 2986); +public static final Boundary MINING_CAMP = new Boundary(3267, 3311, 3000, 3043); +public static final Boundary BEDABIN = new Boundary(3160, 3187, 3015, 3046); +public static final Boundary UZER = new Boundary(3462, 3503, 3068, 3109); +public static final Boundary AGILITY_PYRAMID = new Boundary(3329, 3391, 2812, 2855); +public static final Boundary PYRAMID = new Boundary(3217, 3250, 2881, 2908); +public static final Boundary SOPHANEM = new Boundary(3273, 3323, 2749, 2806); +public static final Boundary MENAPHOS = new Boundary(3200, 3266, 2749, 2806); +public static final Boundary POLLIVNEACH = new Boundary(3329, 3377, 2936, 3002); +public static final Boundary SHANTAY_PASS = new Boundary(3295, 3311, 3116, 3128); +public static final Boundary MORTYANIA = new Boundary(3401, 3773, 3157, 3577); +public static final Boundary[] WILDERNESS = new Boundary[] { new Boundary(2941, 3392, 3518, 3966), new Boundary(2941, 3392, 9922, 10366) }; +public static final Boundary IN_LESSER = new Boundary(3108, 3112, 3156, 3158, 2); +public static final Boundary IN_DUEL = new Boundary(3331, 3391, 3242, 3260); +public static final Boundary[] IN_DUEL_AREA = new Boundary[] { new Boundary(3322, 3394, 3195, 3291), new Boundary(3311, 3323, 3223, 3248) }; +public static final Boundary TRAWLER_GAME = new Boundary (2808, 2811, 3415, 3425); +public static final Boundary PITS_WAIT = new Boundary (2394, 2404, 5169, 5175); +public static final Boundary[] LUMB_BUILDING = new Boundary[] { new Boundary(3205, 3216, 3209, 3228), new Boundary(3229, 3233, 3206, 3208), new Boundary(3228, 3233, 3201, 3205), new Boundary(3230, 3237, 3195, 3198), new Boundary(3238, 3229, 3209, 3211), +public static final Boundary[] DRAYNOR_BUILDING = new Boundary[] { new Boundary(3097, 3102, 3277, 3281), new Boundary(3088, 3092, 3273, 3276), new Boundary(3096, 3102, 3266, 3270), new Boundary(3089, 3095, 3265, 3268), new Boundary(3083, 3088, 3256, 3261), +public static final Boundary VARROCK_BANK_BASEMENT = new Boundary(3186, 3197, 9817, 9824, 0); +public static final Boundary MAGE_TOWER_CAGE = new Boundary(3108, 3112, 3156, 3158, 2); +public static final Boundary ARDOUGNE_ZOO = new Boundary(2593, 2639, 3265, 3288); +public static final Boundary APE_ATOLL = new Boundary(2694, 2811, 2691, 2805); +public static final Boundary BARROWS = new Boundary(3543, 3584, 3265, 3311); +public static final Boundary BARROWS_UNDERGROUND = new Boundary(3529, 3581, 9673, 9722); +public static final Boundary PC_BOAT = new Boundary(2660, 2663, 2638, 2643); +public static final Boundary PC_GAME = new Boundary(2624, 2690, 2550, 2619); +public static final Boundary FIGHT_CAVES = new Boundary(2360, 2445, 5045, 5125); +public static final Boundary PIRATE_HOUSE = new Boundary(3038, 3044, 3949, 3959); +public static final Boundary[] FIGHT_PITS = new Boundary[] { new Boundary(2378, 3415, 5133, 5167), new Boundary(2394, 2404, 5169, 5174) }; +public static final Boundary PARTY_ROOM = new Boundary(2727, 2746, 3460, 3479); +public static final Boundary PARTY_ROOM_TABLE = new Boundary(2735, 2740, 3467, 3468); +public static final Boundary MAGE_TRAINING_ARENA = new Boundary(3330, 3388, 9614, 9727); +public static final Boundary MAGE_TRAINING_ARENA_ENCHANTING = new Boundary(3341, 3386, 9618, 9662, 0); +public static final Boundary MAGE_TRAINING_ARENA_GRAVEYARD = new Boundary(3340, 3386, 9616, 9662, 1); +public static final Boundary MAGE_TRAINING_ARENA_ALCHEMY = new Boundary(3350, 3379, 9616, 9655, 2); +public static final Boundary MAGE_TRAINING_ARENA_TELEKINETIC = new Boundary(3329, 3390, 9665, 9726); +public static final Boundary[] DWARF_NO_FIREMAKING = new Boundary[] { new Boundary(2944, 3072, 3392, 3456), new Boundary(3008, 3072, 3456, 3520), new Boundary(2880, 2944, 3456, 3520) }; ``` diff --git a/docs/Server/classes/BufferUtil.md b/docs/Server/classes/BufferUtil.md index 581c4ce12..852df3c8f 100644 --- a/docs/Server/classes/BufferUtil.md +++ b/docs/Server/classes/BufferUtil.md @@ -12,5 +12,4 @@ public static int readSmart(ByteBuffer buffer) public static String readString(ByteBuffer buffer) public static String readString(ByteBuf buffer) public static int readUnsignedMedium(ByteBuffer buffer) -private BufferUtil() ``` diff --git a/docs/Server/classes/Bushes.md b/docs/Server/classes/Bushes.md index c8bae0ea9..573ca52d0 100644 --- a/docs/Server/classes/Bushes.md +++ b/docs/Server/classes/Bushes.md @@ -9,8 +9,53 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class Bushes { public Bushes(Player player) -private static Map seeds = new HashMap(); public static BushesData forId(int seedId) public int getSeedId() public int getHarvestId() +public int getSeedAmount() +public int getLevelRequired() +public int[] getPaymentToWatch() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public int getLimitState() +public int getCheckHealthState() +public double getCheckHealthXp() +public static BushesFieldsData forId(int npcId) +public static BushesFieldsData forIdPosition(int x, int y) +public int getBushesIndex() +public Point[] getBushesPosition() +public int getNpcId() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateBushesStates() +public int getPlantState(int plantState) +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeed(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvestOrCheckHealth(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public void lowerStage(int index, int timer) +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/CastleWars.md b/docs/Server/classes/CastleWars.md index 1283f6d29..528eed6fc 100644 --- a/docs/Server/classes/CastleWars.md +++ b/docs/Server/classes/CastleWars.md @@ -8,9 +8,34 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/minigames/castl ```java public class CastleWars { -private static HashMap waitingRoom = new HashMap(); -private static HashMap gameRoom = new HashMap(); public static boolean deleteCastleWarsItems(Player c, int itemId) public static void resetPlayer(Player player) public static void collapseCave(int cave) +public static void addToWaitRoom(Player p, int team) +public static void toWaitingRoom(Player p, int team) +public static void returnFlag(Player player, int wearItem) +public static void captureFlag(Player player) +public static void addFlag(Player player, int flagId) +public static void dropFlag(Player player, int flagId) +public static void pickupFlag(Player player) +public static void createHintIcon(Player player, int t) +public static void createFlagHintIcon(int x, int y) +public static int getTeamNumber(Player player) +public static void leaveWaitingRoom(Player player) +public static void process() +public static void updatePlayers() +public static void updateInGamePlayers() +public static void startGame() +public static void endGame() +public static void resetGame() +public static void removePlayerFromCw(Player player) +public static void addCapes(Player p, int capeId) +public static void deleteGameItems(Player player) +public static int getZammyPlayers() +public static int getSaraPlayers() +public static boolean isInCw(Player player) +public static boolean isInCwWait(Player player) +public static void setSaraFlag(int status) +public static void setZammyFlag(int status) +public static void changeFlagObject(int objectId, int team) ``` diff --git a/docs/Server/classes/ChatEmotes.md b/docs/Server/classes/ChatEmotes.md index 6ad5e30a3..96d1682ba 100644 --- a/docs/Server/classes/ChatEmotes.md +++ b/docs/Server/classes/ChatEmotes.md @@ -8,5 +8,4 @@ ChatEmotes.java @author Andrew (Mr Extremez) ```java public enum ChatEmotes { -private ChatEmotes(int animId) ``` diff --git a/docs/Server/classes/ChopTree.md b/docs/Server/classes/ChopTree.md index 4c607f192..d63c971ce 100644 --- a/docs/Server/classes/ChopTree.md +++ b/docs/Server/classes/ChopTree.md @@ -13,4 +13,17 @@ public int getId() public int getLevel() public int getHead() public int getAnimation() +public int getBonus() +public int[] getId() +public int getLevel() +public double getXP() +public int getLog() +public int getStump() +public int getRespawnTime() +public int getDecayChance() +public static boolean handleNest(Player player, int itemId) +public static Axe getAxe(Player player) +public static Tree getTree(int objectId) +public static int getAxeIndex(Player player) +public static int getTreeIndex(final int objectId) ``` diff --git a/docs/Server/classes/ClassUtils.md b/docs/Server/classes/ClassUtils.md index 837a427a0..0a26a63ce 100644 --- a/docs/Server/classes/ClassUtils.md +++ b/docs/Server/classes/ClassUtils.md @@ -9,5 +9,4 @@ A static-utility class containing extension or helper methods for {@link Class}e ```java * A static-utility class containing extension or helper methods for public static Optional getAnnotation(Class clazz, Class annotation) -private ClassUtils() ``` diff --git a/docs/Server/classes/ClickNPC.md b/docs/Server/classes/ClickNPC.md index 20742dab2..7890ebee8 100644 --- a/docs/Server/classes/ClickNPC.md +++ b/docs/Server/classes/ClickNPC.md @@ -13,4 +13,6 @@ public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/ClickObject.md b/docs/Server/classes/ClickObject.md index f8835cbc5..d35c6a602 100644 --- a/docs/Server/classes/ClickObject.md +++ b/docs/Server/classes/ClickObject.md @@ -13,4 +13,14 @@ public void execute(CycleEventContainer container) public void stop() public void processPacket(final Player player, Packet packet) public void completeObjectClick(final Player player, int objectOption) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/ClimbOther.md b/docs/Server/classes/ClimbOther.md index 0dfe57e7b..a14daeedc 100644 --- a/docs/Server/classes/ClimbOther.md +++ b/docs/Server/classes/ClimbOther.md @@ -8,7 +8,6 @@ Climb Other helper class. ```java public class ClimbOther { -private ClimbData(int closedId, int openId) public int getClosed() public int getOpen() public static void handleOpenOther(Player player, int objectType) diff --git a/docs/Server/classes/Climbing.md b/docs/Server/classes/Climbing.md index 7adbbbd02..a77043522 100644 --- a/docs/Server/classes/Climbing.md +++ b/docs/Server/classes/Climbing.md @@ -13,4 +13,7 @@ public void execute(CycleEventContainer container) public void stop() public static void processClimbing(Player client) public static void climbUp(Player player) +public static void climbDown(Player player) +public static void handleLadder(Player player) +public static void handleLadderButtons(Player client, int actionButtonId) ``` diff --git a/docs/Server/classes/CollectionUtil.md b/docs/Server/classes/CollectionUtil.md index 6e551e675..4fd3b2d6b 100644 --- a/docs/Server/classes/CollectionUtil.md +++ b/docs/Server/classes/CollectionUtil.md @@ -9,5 +9,4 @@ A utility class containing helper methods for various {@link Collection} objects ```java * A utility class containing helper methods for various {@link Collection} objects. public static void pollAll(Queue queue, Consumer consumer) -private CollectionUtil() ``` diff --git a/docs/Server/classes/CombatAssistant.md b/docs/Server/classes/CombatAssistant.md index 8231b297b..e8d9a56a4 100644 --- a/docs/Server/classes/CombatAssistant.md +++ b/docs/Server/classes/CombatAssistant.md @@ -13,4 +13,37 @@ public boolean inCombat() public void delayedHit(int i) { // npc hit delay public void applyNpcMeleeDamage(int i, int damageMask) public void fireProjectileNpc() +public void attackingNpcTick() +public void attackingPlayerTick() +public void attackNpc(int i) +public void attackPlayer(int i) +public void playerDelayedHit(int i) +public void applyPlayerMeleeDamage(int i, int damageMask) +public void applySmite(int index, int damage) +public void fireProjectilePlayer() +public void resetPlayerAttack() +public int getCombatDifference(int combat1, int combat2) +public boolean checkReqs() +public int getRequiredDistance() +public void applyRecoilNPC(Player c, int damage, int i) +public void applyRecoil(Player c2, int damage, int i) +public void removeRecoil(Player c2) +public int getBonusAttack(int i) +public boolean checkSpecAmount(int weapon) +public int meleeMaxHit() +public int calcDef() +public int calcAtt() +public void getPlayerAnimIndex() +public int getHitDelay() +public int getAttackDelay() +public int getWepAnim() +public int getBlockEmote() +public int rangeMaxHit() +public boolean checkMagicReqs(int spell) +public int calculateRangeDefence() +public int calculateRangeAttack() +public boolean usingBolts() +public boolean properBolts() +public int mageDef() +public int mageAtk() ``` diff --git a/docs/Server/classes/CombatSounds.md b/docs/Server/classes/CombatSounds.md index 2908efb91..e9b76486c 100644 --- a/docs/Server/classes/CombatSounds.md +++ b/docs/Server/classes/CombatSounds.md @@ -13,4 +13,7 @@ public static int getNpcBlockSound(int NPCID) public static int getNpcDeathSounds(int NPCID) public static String GetNpcName(int NpcID) public static int getMagicSound(Player c, int spellId) +public static int getPlayerBlockSounds(Player c) +public static int getWeaponSounds(Player c) +public static int specialSounds(int id) ``` diff --git a/docs/Server/classes/CommandConsole.md b/docs/Server/classes/CommandConsole.md index 4bb9e2d3e..c0c70adff 100644 --- a/docs/Server/classes/CommandConsole.md +++ b/docs/Server/classes/CommandConsole.md @@ -8,8 +8,6 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/console/CommandConsole.java` ```java public class CommandConsole implements Runnable { -private ArrayList cmds = new ArrayList(); -private CommandConsole() public void run() public static CommandConsole getInstance() ``` diff --git a/docs/Server/classes/Commands.md b/docs/Server/classes/Commands.md index 3141e75e0..7c6547f23 100644 --- a/docs/Server/classes/Commands.md +++ b/docs/Server/classes/Commands.md @@ -1,12 +1,17 @@ # Commands -Package `com.rs2.integrations.discord.commands`. +Package `com.rs2.net.packets.impl`. -Defined in [`2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Commands.java`](2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Commands.java). +Defined in [`2006Scape Server/src/main/java/com/rs2/net/packets/impl/Commands.java`](2006Scape Server/src/main/java/com/rs2/net/packets/impl/Commands.java). Discord commands for . ```java -public class Commands implements MessageCreateListener { -public void onMessageCreate(MessageCreateEvent event) +public class Commands implements PacketType { +public void processPacket(Player player, Packet packet) +public static void playerCommands(Player player, String playerCommand, String[] arguments) +public void run() +public static void moderatorCommands(Player player, String playerCommand, String[] arguments) +public static void adminCommands(Player player, String playerCommand, String[] arguments) +public static void developerCommands(Player player, String playerCommand, String[] arguments) ``` diff --git a/docs/Server/classes/Compost.md b/docs/Server/classes/Compost.md index 109afb28f..7898522ef 100644 --- a/docs/Server/classes/Compost.md +++ b/docs/Server/classes/Compost.md @@ -9,8 +9,38 @@ Created by IntelliJ IDEA. User: vayken Date: 22/02/12 Time: 15:43 To change this ```java public class Compost { public Compost(Player player) -private static Map bins = new HashMap(); public static CompostBinLocations forId(int index) public static CompostBinLocations forPosition(int x, int y) public int getCompostIndex() +public int getBinObjectId() +public int getObjectFace() +public static CompostBinStages forId(int binId) +public int getBinEmpty() +public int getClosedBin() +public int getBinWithCompostable() +public int getBinFullOfCompostable() +public int getBinWithSuperCompostable() +public int getBinFullOFSuperCompostable() +public int getBinWithCompost() +public int getBinFullOfCompost() +public int getBinWithSuperCompost() +public int getBinFullOfSuperCompost() +public int getBinWithTomatoes() +public int getBinFullOfTomatoes() +public int getBinWithRottenTomatoes() +public int getBinFullOfRottenTomatoes() +public void closeCompostBin(final int index) +public void execute(CycleEventContainer container) +public void stop() +public void openCompostBin(final int index) +public void execute(CycleEventContainer container) +public void stop() +public void fillCompostBin(int x, int y, final int organicItemUsed) +public void execute(CycleEventContainer container) +public void stop() +public void retrieveCompost(final int index) +public void execute(CycleEventContainer container) +public void stop() +public boolean handleObjectClick(int objectId, int objectX, int objectY) +public void resetVariables(int index) ``` diff --git a/docs/Server/classes/ConfigLoader.md b/docs/Server/classes/ConfigLoader.md index 026dcb48b..8fac5b690 100644 --- a/docs/Server/classes/ConfigLoader.md +++ b/docs/Server/classes/ConfigLoader.md @@ -9,6 +9,5 @@ Config Loader helper class. ```java public class ConfigLoader { public static void loadSettings(String config) throws IOException -private static void initialize() public static void loadSecrets() throws IOException ``` diff --git a/docs/Server/classes/Connection.md b/docs/Server/classes/Connection.md index 484df33ce..9201b3658 100644 --- a/docs/Server/classes/Connection.md +++ b/docs/Server/classes/Connection.md @@ -13,4 +13,30 @@ public static ArrayList bannedNames = new ArrayList(); public static ArrayList mutedIps = new ArrayList(); public static ArrayList mutedNames = new ArrayList(); public static ArrayList loginLimitExceeded = new ArrayList(); +public static void initialize() +public static void addIpToLoginList(String IP) +public static void removeIpFromLoginList(String IP) +public static void clearLoginList() +public static boolean checkLoginList(String IP) +public static void unMuteUser(String name) +public static void unIPMuteUser(String name) +public static void addIpToBanList(String IP) +public static void addIpToMuteList(String IP) +public static void removeIpFromBanList(String IP) +public static boolean isIpBanned(String IP) +public static void addNameToBanList(String name) +public static void addNameToMuteList(String name) +public static void removeNameFromBanList(String name) +public static void removeNameFromMuteList(String name) +public static void deleteFromFile(String file, String name) +public static boolean isNamedBanned(String name) +public static void banUsers() +public static void muteUsers() +public static void banIps() +public static void muteIps() +public static void addNameToFile(String Name) +public static void addUserToFile(String Name) +public static void addIpToFile(String Name) +public static void addIpToMuteFile(String Name) +public static boolean isMuted(Player player) ``` diff --git a/docs/Server/classes/ConnectionHandler.md b/docs/Server/classes/ConnectionHandler.md index 2921d2c3d..49a92ce8f 100644 --- a/docs/Server/classes/ConnectionHandler.md +++ b/docs/Server/classes/ConnectionHandler.md @@ -1,7 +1,11 @@ # ConnectionHandler -Legacy Netty 4 inbound handler kept for reference. It demonstrates how new -`Session` objects were once created and how packets were forwarded to a -`Client` instance. +Package `com.rs2.net`. -Source: [ConnectionHandler.java](../../2006Scape%20Server/src/main/java/com/rs2/net/ConnectionHandler.java) +Defined in [`2006Scape Server/src/main/java/com/rs2/net/ConnectionHandler.java`](2006Scape Server/src/main/java/com/rs2/net/ConnectionHandler.java). + +Old class that was used with netty 4 impl. This is no longer needed but will be a reference for re-adding the HostList stuff into the ApolloHandler. @author Advocatus + +```java +* Old class that was used with netty 4 impl. This is no longer needed but will be a reference for re-adding the HostList stuff into the ApolloHandler. +``` diff --git a/docs/Server/classes/ConstantReplacer.md b/docs/Server/classes/ConstantReplacer.md index 8c5eee57f..e4dc10912 100644 --- a/docs/Server/classes/ConstantReplacer.md +++ b/docs/Server/classes/ConstantReplacer.md @@ -9,7 +9,4 @@ Introduces constants into an enum. @author Advocatus ```java * Introduces constants into an enum. public static void main(String[] args) throws IllegalArgumentException, IllegalAccessException, ClassNotFoundException -private static void buildSkipped(Class c) -private static Map buildNameMap(Class clazz) -private static boolean skip(String string) ``` diff --git a/docs/Server/classes/ControlPanel.md b/docs/Server/classes/ControlPanel.md index 76d766d43..262424eb6 100644 --- a/docs/Server/classes/ControlPanel.md +++ b/docs/Server/classes/ControlPanel.md @@ -13,4 +13,40 @@ public static void addEntity(String name) public static void removeEntity(String name) public PanelSettings settings() public void initComponents() +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public int getSize() +public Object getElementAt(int i) +public void actionPerformed(ActionEvent evt) +public int getSize() +public Object getElementAt(int i) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void actionPerformed(ActionEvent evt) +public void ActionPerformed(ActionEvent evt) +public void displayMessage(String msg, String title, int type) ``` diff --git a/docs/Server/classes/Cooking.md b/docs/Server/classes/Cooking.md index 1be9f08f7..1eebf1f34 100644 --- a/docs/Server/classes/Cooking.md +++ b/docs/Server/classes/Cooking.md @@ -8,9 +8,13 @@ Cooking helper class. ```java public class Cooking extends SkillHandler { -private static SecureRandom cookingRandom = new SecureRandom(); // The random factor -private CookingItems(int rawItem, int cookedItem, int burntItem, int levelReq, int xp, int stopBurn, int stopBurnGloves, String name) -private int getRawItem() -private int getCookedItem() -private int getBurntItem() +public static CookingItems forId(int itemId) +public static void makeBreadOptions(Player c, int item) +public static void pastryCreation(Player c, int itemID1, int itemID2, int giveItem, String message) +public static void cookingAddon(Player c, int itemID1, int itemID2, int giveItem, int requiredLevel, int expGained) +public static void setCooking(Player player, boolean isCooking) +public static boolean startCooking(Player c, int itemId, int objectId) +public static void cookItem(final Player player, final int itemId, final int amount, final int objectId) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/CookingTutorialIsland.md b/docs/Server/classes/CookingTutorialIsland.md index 882a9edbb..87855158d 100644 --- a/docs/Server/classes/CookingTutorialIsland.md +++ b/docs/Server/classes/CookingTutorialIsland.md @@ -11,6 +11,8 @@ public class CookingTutorialIsland extends SkillHandler { public static void cookThisFood(Player p, int i, int object) public static void getAmount(Player player, int amount) public static void resetCooking(Player c) -private static void viewCookInterface(Player c, int item) -private static void cookTutFish(final Player c) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Coordinate.md b/docs/Server/classes/Coordinate.md index 21425ca91..e9eb9dd10 100644 --- a/docs/Server/classes/Coordinate.md +++ b/docs/Server/classes/Coordinate.md @@ -13,4 +13,9 @@ public Coordinate(int x, int y, int h) public int getX() public int getY() public int getH() +public int getDistance(Coordinate other) +public static int getDistance(Coordinate c1, Coordinate c2) +public int hashCode() +public boolean equals(Object obj) +public String toString() ``` diff --git a/docs/Server/classes/CraftingData.md b/docs/Server/classes/CraftingData.md index a07422eb3..f09f1d07f 100644 --- a/docs/Server/classes/CraftingData.md +++ b/docs/Server/classes/CraftingData.md @@ -13,4 +13,32 @@ public int getAmount(final int button) public int getHideId() public int getLeatherId() public int getPrice() +public int getNameFrame() +public int getCostFrame() +public int getItemFrame() +public String getName() +public int getLeather() +public int getVamb() +public int getChaps() +public int getBody() +public static Leather forId(int itemUsed, int usedWith) +public int getLeather() +public int getProduct() +public int amountOfLeather4Product() +public int getLevel() +public double getXp() +public int getButtonId(final int button) +public int getAmount(final int button) +public int getLeather() +public int getProduct() +public int getLevel() +public double getXP() +public int getHideAmount() +public int getUncut() +public int getCut() +public int getLevel() +public double getXP() +public int getAnimation() +public int getAmuletId() +public int getProduct() ``` diff --git a/docs/Server/classes/CrystalChest.md b/docs/Server/classes/CrystalChest.md index ef128a63a..a14627d9f 100644 --- a/docs/Server/classes/CrystalChest.md +++ b/docs/Server/classes/CrystalChest.md @@ -13,4 +13,6 @@ public static boolean canOpen(Player c) public void execute(CycleEventContainer container) public void stop() public static int getLength() +public static int toothHalf() +public static int loopHalf() ``` diff --git a/docs/Server/classes/CustomPrintStream.md b/docs/Server/classes/CustomPrintStream.md index 2b0816db7..79e8df92a 100644 --- a/docs/Server/classes/CustomPrintStream.md +++ b/docs/Server/classes/CustomPrintStream.md @@ -8,9 +8,8 @@ Custom Print Stream helper class. ```java public class CustomPrintStream extends PrintStream { -private final SimpleDateFormat dateFormat = new SimpleDateFormat("MM-dd-yyyy hh:mm:ss a"); -private final ExecutorService executor = Executors.newSingleThreadExecutor(); public CustomPrintStream(OutputStream out, String logType, boolean fileOutput) throws IOException -private void log(String message) public void println(String x) +public void close() +public static void main(String[] args) throws IOException ``` diff --git a/docs/Server/classes/CycleEventContainer.md b/docs/Server/classes/CycleEventContainer.md index 31b2f4e4a..1ee28480a 100644 --- a/docs/Server/classes/CycleEventContainer.md +++ b/docs/Server/classes/CycleEventContainer.md @@ -13,4 +13,8 @@ public void execute() public void stop() public boolean needsExecution() public Object getOwner() +public boolean isRunning() +public int getID() +public int getTick() +public void setTick(int tick) ``` diff --git a/docs/Server/classes/CycleEventHandler.md b/docs/Server/classes/CycleEventHandler.md index 216c007ef..37f0edd61 100644 --- a/docs/Server/classes/CycleEventHandler.md +++ b/docs/Server/classes/CycleEventHandler.md @@ -13,4 +13,8 @@ public CycleEventHandler() public CycleEventContainer addEvent(int id, Object owner, CycleEvent event, int cycles) public CycleEventContainer addEvent(Object owner, CycleEvent event, int cycles) public void process() +public int getEventsCount() +public void stopEvents(Object owner) +public void stopEvents(Object owner, int id) +public void stopEvents(int id) ``` diff --git a/docs/Server/classes/DairyChurn.md b/docs/Server/classes/DairyChurn.md index b209c3740..2a3c86816 100644 --- a/docs/Server/classes/DairyChurn.md +++ b/docs/Server/classes/DairyChurn.md @@ -13,4 +13,9 @@ public static ChurnData forId(int id) public int getButtonId() public int[] getUsed() public int getResult() +public int getLevel() +public double getExperience() +public static void churnItem(final Player player, int buttonId) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/DesertCactus.md b/docs/Server/classes/DesertCactus.md index 93e5f30f1..3f6cf9dab 100644 --- a/docs/Server/classes/DesertCactus.md +++ b/docs/Server/classes/DesertCactus.md @@ -8,9 +8,9 @@ Desert Cactus helper class. ```java public class DesertCactus { -private static final int CACTUS_DELAY = 20 + Misc.random(5); public static int getCacCutter(Player player) public static void checkCactus(Player c, int objectId, int obX, int obY) public static void cutCactus(final Player c, int itemId, final int objectId, final int obX, final int obY) public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/DesertHeat.md b/docs/Server/classes/DesertHeat.md index 5fcd5a777..7d958d2ca 100644 --- a/docs/Server/classes/DesertHeat.md +++ b/docs/Server/classes/DesertHeat.md @@ -8,9 +8,9 @@ Aug 12, 2017 : 1:51:21 AM DesertHeat.java @author Andrew (Mr Extremez) ```java public class DesertHeat { -private static int DAMAGE = 1+Misc.random(8); -private static void doDamage(Player player) -private static int getClothes(Player player) -private static int getTimer(Player player) -private static boolean preventHeat(Player player) +public static void callHeat(final Player player) +public void execute(CycleEventContainer container) +public void stop() +public static boolean checkWaterskin(final Player player) +public static void showWarning(Player player) ``` diff --git a/docs/Server/classes/DialogueHandler.md b/docs/Server/classes/DialogueHandler.md index c6d7afda3..d4c620eff 100644 --- a/docs/Server/classes/DialogueHandler.md +++ b/docs/Server/classes/DialogueHandler.md @@ -13,4 +13,17 @@ public void endDialogue() public void setOptionId(int id) public void setNextDialogue(int id) public void sendDialogues(int dialogue, int npcId) +public void sendDialogues2(int dialogue, int npcId) +public void clearChatBoxText(Player c) +public void sendStartInfo(String text, String text1, String text2, String text3, String title, boolean send) +public void sendPlayerChat(String... line) +public void sendPlayerChat(ChatEmotes e, String... line) +public void sendOption(String... line) +public void sendStatement(String... line) +public void itemMessage(String title, String message, int itemid, int size) +public void sendNpcChat(int npcId, ChatEmotes e, String... line) +public void sendNpcChat1(String s, int ChatNpc, String name) +public void sendNpcChat2(String s, String s1, int ChatNpc, String name) +public void itemMessage(String message1, int itemid, int size) +public void sendItemChat(int item, int zoom, String header, String... line) ``` diff --git a/docs/Server/classes/DoorData.md b/docs/Server/classes/DoorData.md index 58bb3734e..8cbda494c 100644 --- a/docs/Server/classes/DoorData.md +++ b/docs/Server/classes/DoorData.md @@ -13,4 +13,7 @@ public int getId() public Location[] getLocations() public int getFace() public int getType() +public int getX() +public int getY() +public int getHeight() ``` diff --git a/docs/Server/classes/Doors.md b/docs/Server/classes/Doors.md index 0b68e8f13..a5cf4c18d 100644 --- a/docs/Server/classes/Doors.md +++ b/docs/Server/classes/Doors.md @@ -8,9 +8,7 @@ Doors helper class. ```java public class Doors { -private final List doors = new ArrayList<>(); public static Doors getSingleton() -private Doors(String file) -private Doors(int door, int x, int y, int z, int face, int type, int open) -private Doors getDoor(int id, int x, int y, int z) +public boolean handleDoor(Player player, int id, int x, int y, int z) +public void load() ``` diff --git a/docs/Server/classes/DoubleDoors.md b/docs/Server/classes/DoubleDoors.md index e8e824ab8..ae9fb3760 100644 --- a/docs/Server/classes/DoubleDoors.md +++ b/docs/Server/classes/DoubleDoors.md @@ -8,9 +8,11 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/globalworldobjects/Doub ```java public class DoubleDoors { -private final List doors = new ArrayList<>(); public static DoubleDoors getSingleton() -private DoubleDoors(String file) -private DoubleDoors getDoor(int id, int x, int y, int z) public boolean handleDoor(Player player, int id, int x, int y, int z) +public void changeLeftDoor(DoubleDoors d) +public void changeRightDoor(DoubleDoors d) +public DoubleDoors(int id, int x, int y, int z, int f, int open) +public boolean isOpenDoor(int id) +public void load() ``` diff --git a/docs/Server/classes/Dueling.md b/docs/Server/classes/Dueling.md index 2b985f617..f6ca20182 100644 --- a/docs/Server/classes/Dueling.md +++ b/docs/Server/classes/Dueling.md @@ -13,4 +13,21 @@ public CopyOnWriteArrayList otherStakedItems = new CopyOnWriteArrayLis public CopyOnWriteArrayList stakedItems = new CopyOnWriteArrayList(); public void requestDuel(int id) public void openDuel() +public void sendDuelEquipment(int itemId, int amount, int slot) +public void refreshduelRules() +public void refreshDuelScreen() +public boolean stakeItem(int itemID, int fromSlot, int amount) +public boolean fromDuel(int itemID, int fromSlot, int amount) +public void confirmDuel() +public void startDuel() +public static void handleForfeit(Player player) +public void duelVictory() +public void duelRewardInterface() +public void claimStakedItems() +public void declineDuel() +public void checkDuelWalk() +public void resetDuel() +public void resetDuelItems() +public void changeDuelStuff() +public void selectRule(int i) { // rules ``` diff --git a/docs/Server/classes/DwarfCannon.md b/docs/Server/classes/DwarfCannon.md index b03f6594e..63e88d4ac 100644 --- a/docs/Server/classes/DwarfCannon.md +++ b/docs/Server/classes/DwarfCannon.md @@ -13,4 +13,28 @@ public static void makeBall(Player player) public void execute(CycleEventContainer container) public void stop() public void placeCannon() +public void execute(CycleEventContainer container) +public void stop() +public void loginCheck() +public boolean hasCannon() +public int getBalls() +public boolean nearCannon() +public void loadCannons() +public void loadCannon(int x, int y) +public void clickCannon(int x, int y) +public void handleDisconnect() +public void handleDeath() +public void shoot() +public void execute(CycleEventContainer e) +public void stop() +public void removeCannon(int x, int y) +public void pickup(int x, int y) +public void placeObject(int id, int x, int y, boolean add) +public void removeObject(int x, int y) +public boolean noSetUpArea() +public void shootNpcs() +public boolean inDistance(int npcX, int npcY) +public boolean canAttackSlayer(int i) +public int getShootXPos() +public int getShootYPos() ``` diff --git a/docs/Server/classes/Dye.md b/docs/Server/classes/Dye.md index 7ebeab4b3..b38e85e29 100644 --- a/docs/Server/classes/Dye.md +++ b/docs/Server/classes/Dye.md @@ -8,9 +8,6 @@ Dye.java @author Andrew (Mr Extremez) ```java public enum Dye { -private Dye(int itemUsed, int reward) -private int getItemUsed() -private int getReward() public static boolean blockDye(Player player, Dye dye, int itemUsed, int useWith) public static void dyeItem(Player player, int itemUsed, int useWith) ``` diff --git a/docs/Server/classes/Ectofuntus.md b/docs/Server/classes/Ectofuntus.md index 95f8fb241..a931b7468 100644 --- a/docs/Server/classes/Ectofuntus.md +++ b/docs/Server/classes/Ectofuntus.md @@ -13,4 +13,17 @@ public int getBonemealId() public double getWorshipExperience() public static void boneOnLoader(Player player, int objectId, int boneId) public void execute(CycleEventContainer container) +public void stop() +public static void useBoneGrinder(Player player) +public void execute(CycleEventContainer container) +public void stop() +public static void emptyBin(Player player) +public void execute(CycleEventContainer container) +public void stop() +public static void handleEctofuntus(Player player) +public void execute(CycleEventContainer container) +public void stop() +public static void fillBucketWithSlime(Player player, final int objectId) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/EmoteHandler.md b/docs/Server/classes/EmoteHandler.md index 069c2f84e..0b848be6a 100644 --- a/docs/Server/classes/EmoteHandler.md +++ b/docs/Server/classes/EmoteHandler.md @@ -9,7 +9,6 @@ Handles emote related functionality. ```java public class EmoteHandler { public EmoteHandler(Player player2) -private Emotes(int buttonId, int animId, int gfxId) public static HashMap emotes = new HashMap(); public static Emotes loadEmote(int buttonId) public void startEmote(int buttonId) diff --git a/docs/Server/classes/EnchantStaff.md b/docs/Server/classes/EnchantStaff.md index 6caa43daf..c8f85dac0 100644 --- a/docs/Server/classes/EnchantStaff.md +++ b/docs/Server/classes/EnchantStaff.md @@ -11,6 +11,7 @@ public class EnchantStaff { public static boolean staffButtons(Player player, int button) public static HashMap craftingStaff = new HashMap(); public static staffData forId(int id) -private staffData(int button, int battlestaff, int mysticstaff) public int getButton() +public int getBattlestaff() +public int getMysticstaff() ``` diff --git a/docs/Server/classes/Enchanting.md b/docs/Server/classes/Enchanting.md index 02b0fa386..a441c0ddd 100644 --- a/docs/Server/classes/Enchanting.md +++ b/docs/Server/classes/Enchanting.md @@ -1,16 +1,17 @@ # Enchanting -Package `com.rs2.game.content.combat.magic`. +Package `com.rs2.game.content.minigames.magetrainingarena`. -Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/combat/magic/Enchanting.java`](2006Scape Server/src/main/java/com/rs2/game/content/combat/magic/Enchanting.java). +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/minigames/magetrainingarena/Enchanting.java`](2006Scape Server/src/main/java/com/rs2/game/content/minigames/magetrainingarena/Enchanting.java). Enchanting helper class. ```java public class Enchanting { -public Enchanting(Player player) -private Enchant(int unenchanted, int enchanted, int reqEnchantmentLevel) -public int getUnenchanted() -public int getEnchanted() -public int getELevel() +public Enchanting(Player c) +public void enchantItem(int itemID, int spellID) +public void deposit() +public void clearItems() +public static void process() +public static void updateInterface(Player player) ``` diff --git a/docs/Server/classes/EquipmentConstants.md b/docs/Server/classes/EquipmentConstants.md index 83d9360cd..80bdd70cf 100644 --- a/docs/Server/classes/EquipmentConstants.md +++ b/docs/Server/classes/EquipmentConstants.md @@ -11,5 +11,4 @@ public final class EquipmentConstants { public static final String[] ARROWS = { "arrow", "arrows", "arrow(p)", "arrow(+)", "arrow(s)", "bolt", "Bolt rack", public static final String[] LEGS = { "platelegs", "plateskirt", "skirt", "bottoms", "chaps", "platelegs (t)", public static final String[] SHIELDS = { "kiteshield", "sq shield", "Toktz-ket", "books", "book", "kiteshield (t)", -private EquipmentConstants() ``` diff --git a/docs/Server/classes/EquipmentDefinition.md b/docs/Server/classes/EquipmentDefinition.md index 7374d3173..23b5f9064 100644 --- a/docs/Server/classes/EquipmentDefinition.md +++ b/docs/Server/classes/EquipmentDefinition.md @@ -8,9 +8,26 @@ Represents a type of Item that may be equipped. @author Graham ```java public final class EquipmentDefinition { -private static final Map definitions = new HashMap<>(); public static int count() public static void init(EquipmentDefinition[] definitions) public static EquipmentDefinition lookup(int id) public EquipmentDefinition(int id) +public int getAttackLevel() +public int getDefenceLevel() +public int getHitpointsLevel() +public int getMagicLevel() +public int getPrayerLevel() +public int getRangedLevel() +public int getStrengthLevel() +public int getId() +public int getLevel(int skill) +public int getSlot() +public boolean isFullBody() +public boolean isFullHat() +public boolean isFullMask() +public boolean isTwoHanded() +public void setFlags(boolean twoHanded, boolean fullBody, boolean fullHat, boolean fullMask) +public void setLevels(int attack, int strength, int defence, int ranged, int prayer, int magic) +public void setLevels(int attack, int strength, int defence, int hitpoints, int ranged, int prayer, int magic) +public void setSlot(int slot) ``` diff --git a/docs/Server/classes/EquipmentUpdater.md b/docs/Server/classes/EquipmentUpdater.md index 95d0a4a87..aebce80de 100644 --- a/docs/Server/classes/EquipmentUpdater.md +++ b/docs/Server/classes/EquipmentUpdater.md @@ -9,8 +9,4 @@ A tool for updating the equipment data. @author Graham @author Palidino76 ```java public final class EquipmentUpdater { public static void main(String[] args) throws Exception -private static int getAttackRequirement(ItemDefinition definition) -private static int getDefenceRequirement(ItemDefinition definition) -private static int getMagicRequirement(ItemDefinition definition) -private static int getPrayerRequirement(ItemDefinition definition) ``` diff --git a/docs/Server/classes/Farmers.md b/docs/Server/classes/Farmers.md index 8e6e8bc07..47ead85c8 100644 --- a/docs/Server/classes/Farmers.md +++ b/docs/Server/classes/Farmers.md @@ -8,9 +8,12 @@ Created by IntelliJ IDEA. User: vayken Date: 19/04/12 Time: 02:42 To change this ```java public class Farmers { -private static Map npcs = new HashMap(); public static FarmersData forId(int npcId) public int getNpcId() public String getFieldProtected() public String[] getDialogueHandlerOptions() +public int getShopId() +public static void chopDownTree(Player player, int npcId) +public static void sendFarmingAdvice(Player player) +public static String getFinalPaymentString(String word) ``` diff --git a/docs/Server/classes/FightCaves.md b/docs/Server/classes/FightCaves.md index 05077f6a3..4802b805c 100644 --- a/docs/Server/classes/FightCaves.md +++ b/docs/Server/classes/FightCaves.md @@ -13,4 +13,14 @@ public static void ytMejKotEffect(Client player, int i) public static void spawnHealers(Player c, int i, int amount) public static void tzKihEffect(Client player, int i, int damage) public static void tzKekEffect(Client player, int i) +public static int getHp(int npc) +public static int getMax(int npc) +public static int getAtk(int npc) +public static int getDef(int npc) +public void execute(CycleEventContainer container) +public void stop() +public static void handleJadDeath(int i) +public static void healJad(Player c, int i) +public static void tzhaarDeathHandler(int i) +public static boolean isFightCaveNpc(int i) ``` diff --git a/docs/Server/classes/FightPits.md b/docs/Server/classes/FightPits.md index 03f4efbc9..8771154ee 100644 --- a/docs/Server/classes/FightPits.md +++ b/docs/Server/classes/FightPits.md @@ -10,7 +10,10 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/minigames/Fight public class FightPits { public static String getState(Player player) public static void addPlayer(Player c) -private static void enterGame(Player c) public static void removePlayer(Player player, boolean forceRemove) public static int getListCount(String state) +public static boolean updateWaitingRoom(Player c) +public static boolean updateGame(Player c) +public static void handleDeath(Player player) +public static void process() ``` diff --git a/docs/Server/classes/FileServer.md b/docs/Server/classes/FileServer.md index 2dfa01046..0da5faacb 100644 --- a/docs/Server/classes/FileServer.md +++ b/docs/Server/classes/FileServer.md @@ -8,9 +8,8 @@ The core class of the file server. @author Graham ```java * The core class of the file server. -private final EventLoopGroup loopGroup = new NioEventLoopGroup(); -private final ServerBootstrap serviceBootstrap = new ServerBootstrap(); -private static final Logger logger = Logger.getLogger(FileServer.class.getName()); public SocketAddress service = new InetSocketAddress((Constants.WORLD == 1) ? 43594 : 43596 + Constants.WORLD); public void start() throws Exception +public void init() throws Exception +public void bind(SocketAddress service, SocketAddress http, SocketAddress jaggrab) throws IOException ``` diff --git a/docs/Server/classes/FileSystemConstants.md b/docs/Server/classes/FileSystemConstants.md index a6433bc2f..e55601c12 100644 --- a/docs/Server/classes/FileSystemConstants.md +++ b/docs/Server/classes/FileSystemConstants.md @@ -8,5 +8,4 @@ Holds file system related constants. @author Graham ```java public final class FileSystemConstants { -private FileSystemConstants() ``` diff --git a/docs/Server/classes/Firemaking.md b/docs/Server/classes/Firemaking.md index 5955da95f..617488bdf 100644 --- a/docs/Server/classes/Firemaking.md +++ b/docs/Server/classes/Firemaking.md @@ -13,4 +13,7 @@ public static void attemptFire(final Player c, final int itemUsed, final int use public void execute(CycleEventContainer container) public void execute(CycleEventContainer container) public void stop() +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Fishing.md b/docs/Server/classes/Fishing.md index dc82f4e13..db6db4b2c 100644 --- a/docs/Server/classes/Fishing.md +++ b/docs/Server/classes/Fishing.md @@ -9,8 +9,16 @@ Fishing helper class. ```java public class Fishing extends SkillHandler { public static void randomEvents(Player client) -private static void attemptdata(final Player c, final int npcId) public void execute(CycleEventContainer container) public void stop() public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public static boolean hasFishingEquipment(Player c, int equipment) +public static void resetFishing(Player player) +public static String messages(Player c) +public static void fishingNPC(Player c, int i, int l) +public static boolean fishingNPC(Player c, int npc) ``` diff --git a/docs/Server/classes/Flowers.md b/docs/Server/classes/Flowers.md index 8485129fb..5d50bbb87 100644 --- a/docs/Server/classes/Flowers.md +++ b/docs/Server/classes/Flowers.md @@ -1,16 +1,58 @@ # Flowers -Package `com.rs2.game.items.impl`. +Package `com.rs2.game.content.skills.farming`. -Defined in [`2006Scape Server/src/main/java/com/rs2/game/items/impl/Flowers.java`](2006Scape Server/src/main/java/com/rs2/game/items/impl/Flowers.java). +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/farming/Flowers.java`](2006Scape Server/src/main/java/com/rs2/game/content/skills/farming/Flowers.java). -@author Faris +Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this template use File | Settings | File Templates. ```java -public class Flowers { -private static int flowerDecoder(final int flower) -public Flowers(final Player c) +public class Flowers { // todo scarecrow 6059 +public Flowers(Player player) +public static FlowerData forId(int seedId) +public int getSeedId() +public int getHarvestId() +public int getLevelRequired() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public static FlowerFieldsData forIdPosition(Point point) +public int getFlowerIndex() +public Point[] getFlowerPosition() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateFlowerStates() +public int getPlantState(int plantState) +public void doCalculations() +public void doStateCalculation(int index) +public boolean waterPatch(int objectX, int objectY, int itemId) public void execute(CycleEventContainer container) public void stop() -private void executeAction(final Player c) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeed(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvest(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantScareCrow(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/Food.md b/docs/Server/classes/Food.md index a71c36aa6..e1fd4dce1 100644 --- a/docs/Server/classes/Food.md +++ b/docs/Server/classes/Food.md @@ -8,9 +8,10 @@ Food helper class. ```java public class Food { -private boolean hasEffect() -private int getId() -private FoodType getType() -private int getHeal() public int replaceWith() +public static HashMap food = new HashMap(); +public int random(int r) +public static void eat(Player player, int id, int slot) +public static void foodEffect(Player player, int id) +public static boolean isFood(int id) ``` diff --git a/docs/Server/classes/Frog.md b/docs/Server/classes/Frog.md index 4a545df12..13aff8558 100644 --- a/docs/Server/classes/Frog.md +++ b/docs/Server/classes/Frog.md @@ -13,4 +13,5 @@ public static void finishEvent(Client client) {// breaks public static void spawnBasedOnGender(Client client) {// ternary public static void ignoreFrogs(Client client) public static void giveReward(Client client) +public static void spawnFrogs(Client client) ``` diff --git a/docs/Server/classes/FruitTree.md b/docs/Server/classes/FruitTree.md index 298367029..889c49040 100644 --- a/docs/Server/classes/FruitTree.md +++ b/docs/Server/classes/FruitTree.md @@ -9,8 +9,58 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class FruitTree { public FruitTree(Player player) -private static Map saplings = new HashMap(); public static FruitTreeData forId(int saplingId) public int getSapplingId() public int getHarvestId() +public int getSapplingAmount() +public int getLevelRequired() +public int[] getPaymentToWatch() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public int getLimitState() +public int getStumpState() +public int getCheckHealthState() +public double getCheckHealthXp() +public int getDiseaseDiffValue() +public int getDeathDiffValue() +public static FruitTreeFieldsData forId(int npcId) +public static FruitTreeFieldsData forIdPosition(int x, int y) +public int getFruitTreeIndex() +public Point[] getFruitTreePosition() +public int getNpcId() +public static InspectData forId(int saplingId) +public int getSapplingId() +public String[][] getMessages() +public void updateFruitTreeStates() +public void doCalculations() +public boolean cut(final int x, final int y) +public void execute(CycleEventContainer container) +public void stop() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSapling(int objectX, int objectY, final int saplingId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvestOrCheckHealth(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public void lowerStage(int index, int timer) +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean pruneArea(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/GameEngine.md b/docs/Server/classes/GameEngine.md index c29d6a73a..f11447fb6 100644 --- a/docs/Server/classes/GameEngine.md +++ b/docs/Server/classes/GameEngine.md @@ -1,22 +1,24 @@ # GameEngine -The main entry point for running the server. `GameEngine` bootstraps every -subsystem and runs the core game loop once every few hundred milliseconds. +Package `com.rs2`. -Highlights: +Defined in [`2006Scape Server/src/main/java/com/rs2/GameEngine.java`](2006Scape Server/src/main/java/com/rs2/GameEngine.java). -- Loads configuration, caches and plugins on startup. -- Accepts network connections and exposes the Netty based pipeline. -- Schedules the primary tick which updates players, NPCs and objects. - -Source: [GameEngine.java](../../2006Scape%20Server/src/main/java/com/rs2/GameEngine.java) +Server.java @author Sanity @author Graham @author Blake @author Ryan Lmctruck30 @author Integration Julian. ```java -public static void main(String[] args) throws IOException { - System.out.println("Starting game engine.."); - FileServer fs = new FileServer(); - fs.start(); - scheduler.scheduleAtFixedRate(() -> playerHandler.process(), - 0, Constants.CYCLE_TIME, TimeUnit.MILLISECONDS); -} +public class GameEngine { +public static long getMinutesCounter() +public static long lastMassSave = System.currentTimeMillis(); +public static ItemHandler itemHandler = new ItemHandler(); +public static PlayerHandler playerHandler = new PlayerHandler(); +public static NpcHandler npcHandler = new NpcHandler(); +public static ShopHandler shopHandler = new ShopHandler(); +public static ObjectHandler objectHandler = new ObjectHandler(); +public static ObjectManager objectManager = new ObjectManager(); +public static FightCaves fightCaves = new FightCaves(); +public static Trawler trawler = new Trawler(); +public static void main(java.lang.String[] args) +public void run() +public static long getServerStartTime() ``` diff --git a/docs/Server/classes/GameObject.md b/docs/Server/classes/GameObject.md index 09a43a05c..412487052 100644 --- a/docs/Server/classes/GameObject.md +++ b/docs/Server/classes/GameObject.md @@ -13,4 +13,5 @@ public int id() public int type() public int x() public int y() +public int getFace() ``` diff --git a/docs/Server/classes/GameSession.md b/docs/Server/classes/GameSession.md index c8f2725c8..6604a1e3f 100644 --- a/docs/Server/classes/GameSession.md +++ b/docs/Server/classes/GameSession.md @@ -13,4 +13,8 @@ public GameSession(Channel channel, Player player, boolean reconnecting) public void destroy() public boolean isReconnecting() public void messageReceived(Object message) +public SocketAddress getRemoteAddress() +public void close() +public boolean isActive() +public void write(ByteBuf buf) ``` diff --git a/docs/Server/classes/GateHandler.md b/docs/Server/classes/GateHandler.md index 5c0dd40c3..afd30a1ac 100644 --- a/docs/Server/classes/GateHandler.md +++ b/docs/Server/classes/GateHandler.md @@ -11,6 +11,7 @@ public class GateHandler { public boolean isGate(int objectId) public void spawnGate(Player player, int objectId, int newObjectX, int newObjectY, int height, int face) public void openSingleGate(Player player, int objectId, int newObjectX, int newObjectY, int oldObjectX, int oldObjectY, int walkX, int walkY, int newFace, int oldFace) -private void openDoubleGate(Player player, int objectId, int objectId2, int newObjectX, int newObjectY, int newObjectX2, int newObjectY2, int oldObjectX, int oldObjectY, int oldObjectX2, int oldObjectY2, int newFace, int oldFace) -private void openSpecialGate(Player player, int objectId, int objectId2, int newObjectX, int newObjectY, int newObjectX2, int newObjectY2, int oldObjectX, int oldObjectY, int oldObjectX2, int oldObjectY2, int newFace, int newFace2, int oldFace) +public void openMetalGateWalk(Player player, int objectId, int objectId2, int newObjectX, int newObjectY, int newObjectX2, int newObjectY2, int oldObjectX, int oldObjectY, int oldObjectX2, int oldObjectY2, int walkX, int walkY, int newFace, int newFace2, int oldFace) +public void handleWoodenGate(Player player, int objectId, int objectId2, int newObjectX, int newObjectY, int newObjectX2, int newObjectY2, int oldObjectX, int oldObjectY, int oldObjectX2, int oldObjectY2, int type) +public void handleMetalGate(Player player, int objectId, int objectId2, int newObjectX, int newObjectY, int newObjectX2, int newObjectY2, int oldObjectX, int oldObjectY, int oldObjectX2, int oldObjectY2, int type) ``` diff --git a/docs/Server/classes/GenieLamp.md b/docs/Server/classes/GenieLamp.md index e38995fe2..f00c9f231 100644 --- a/docs/Server/classes/GenieLamp.md +++ b/docs/Server/classes/GenieLamp.md @@ -11,6 +11,5 @@ public class GenieLamp { public static boolean spawnGenieNpc(Client c) public static void removeGenieNpc(Client c) public static void rubGenieLamp(Client c, int itemId) -private static void whatSkillAreWeLookingFor(Client c, int actionButtonId) public static boolean genieInterfaceButtons(Client c, int actionButtonId) ``` diff --git a/docs/Server/classes/GlassBlowing.md b/docs/Server/classes/GlassBlowing.md index 15c0a3edb..01ef942aa 100644 --- a/docs/Server/classes/GlassBlowing.md +++ b/docs/Server/classes/GlassBlowing.md @@ -13,4 +13,8 @@ public boolean getStarted() public void setStarted(boolean started) public void showInterface() public void ItemOnItem(int id, int id2) +public void handleActionButtin(int buttonId) +public void makeItem(final int id, final int amount, final int slot) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/GlobalDropsHandler.md b/docs/Server/classes/GlobalDropsHandler.md index b65afcf5f..9a424a1b7 100644 --- a/docs/Server/classes/GlobalDropsHandler.md +++ b/docs/Server/classes/GlobalDropsHandler.md @@ -8,9 +8,26 @@ Handles global drops which respawn after set amount of time when taken @author ```java public class GlobalDropsHandler { -private static final List globalDrops = new ArrayList<>(); -private static final Set spawnedDrops = new HashSet<>(); public static void initialize() public void execute(CycleEventContainer container) public void stop() +public static void writeGlobalDropsDump() +public static boolean itemExists(int itemID, int itemX, int itemY, boolean yes) +public static void pickup(Player player, int itemID, int itemX, int itemY) +public static void load(Client player) +public static void reset(Player c) +public GlobalDrop(int id, int amount, int itemX, int itemY) +public GlobalDrop(int id, int amount, int itemX, int itemY, int height) +public int getX() +public int getY() +public int getId() +public int getAmount() +public boolean isTaken() +public void setTaken(boolean a) +public void setTakenAt(long a) +public long getTakenAt() +public boolean isSpawned() +public void setSpawned(boolean spawned) +public int getHeight() +public void setHeight(int height) ``` diff --git a/docs/Server/classes/GnomeGlider.md b/docs/Server/classes/GnomeGlider.md index 99154a318..d6d429a37 100644 --- a/docs/Server/classes/GnomeGlider.md +++ b/docs/Server/classes/GnomeGlider.md @@ -13,4 +13,11 @@ public static void handleFlight(final Player player, final int flightId) public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) +public void stop() +public static int getLength() +public static int getButton(int i) +public static int getX(int i) +public static int getY(int i) +public static int getH(int i) +public static int getMove(int i) ``` diff --git a/docs/Server/classes/GodBooks.md b/docs/Server/classes/GodBooks.md index b50996f39..663cec9d8 100644 --- a/docs/Server/classes/GodBooks.md +++ b/docs/Server/classes/GodBooks.md @@ -8,9 +8,8 @@ Handles the preaching of god books @author Final Project ```java public enum GodBooks { -private GodBooks(int itemId, String[][] preachData) -private static Map godBooks = new HashMap(); public static void sendPreachOptions(Player player, int itemId) public static void handlePreach(Player player, int itemId, int actionButtonId) public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Graveyard.md b/docs/Server/classes/Graveyard.md index 9f063a69d..c731e963d 100644 --- a/docs/Server/classes/Graveyard.md +++ b/docs/Server/classes/Graveyard.md @@ -13,4 +13,7 @@ public void searchBonePile(int objectID) public void bonesToFood(int spellID) public void depositFood() public void clearItems() +public static void process() +public static void applyDamage(Player player) +public static void updateInterface(Player player) ``` diff --git a/docs/Server/classes/Greegree.md b/docs/Server/classes/Greegree.md index b226b7409..7ac53c988 100644 --- a/docs/Server/classes/Greegree.md +++ b/docs/Server/classes/Greegree.md @@ -8,9 +8,19 @@ Greegree helper class. ```java public class Greegree { -private MonkeyData(int greegreeID, int npcID, int standAnim, int walkAnim, int runAnim, int attackAnim, int blockAnim) public int getGreegreeID() public int getNpcID() public int getStandAnim() public int getWalkAnim() +public int getRunAnim() +public int getBlockAnim() +public int getAttackAnim() +public static MonkeyData forId(int id) +public static boolean isWearingGreegree(Player p) +public static boolean isAnim(int animId) +public static boolean canWear(Player player) +public static boolean attemptGreegree(Player p, int weaponID) +public static void setAnimations(Player p, MonkeyData data) +public static void resetAnimations(Player p) +public static boolean attemptRemove(Player p, int slot) ``` diff --git a/docs/Server/classes/GroundItem.md b/docs/Server/classes/GroundItem.md index 349d88f3d..745aabc7d 100644 --- a/docs/Server/classes/GroundItem.md +++ b/docs/Server/classes/GroundItem.md @@ -13,4 +13,6 @@ public int getItemX() public int getItemY() public int getItemH() public int getItemAmount() +public int getItemController() +public String getName() ``` diff --git a/docs/Server/classes/HandshakeConstants.md b/docs/Server/classes/HandshakeConstants.md index 5d62691fd..193f67cec 100644 --- a/docs/Server/classes/HandshakeConstants.md +++ b/docs/Server/classes/HandshakeConstants.md @@ -8,5 +8,4 @@ Holds handshake-related constants. @author Graham ```java public final class HandshakeConstants { -private HandshakeConstants() ``` diff --git a/docs/Server/classes/HandshakeDecoder.md b/docs/Server/classes/HandshakeDecoder.md index 141908d5e..fa38b7bb4 100644 --- a/docs/Server/classes/HandshakeDecoder.md +++ b/docs/Server/classes/HandshakeDecoder.md @@ -8,6 +8,4 @@ A {@link ByteToMessageDecoder} which decodes the handshake and makes changes to ```java public final class HandshakeDecoder extends ByteToMessageDecoder { -private static final Logger logger = Logger.getLogger(HandshakeDecoder.class.getName()); -protected void decode(ChannelHandlerContext ctx, ByteBuf buffer, List out) ``` diff --git a/docs/Server/classes/Herblore.md b/docs/Server/classes/Herblore.md index 4a5957b7b..8b4a6c1e2 100644 --- a/docs/Server/classes/Herblore.md +++ b/docs/Server/classes/Herblore.md @@ -13,4 +13,9 @@ public static void makePotion(final Player c, int amount) public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) +public void stop() +public static void resetHerblore(Player player) +public static boolean isHerb(int item) +public static boolean isIngredient(int item) +public static void handleHerbloreButtons(Player player, int actionButtonId) ``` diff --git a/docs/Server/classes/Herbs.md b/docs/Server/classes/Herbs.md index 9aaee88eb..a783d9026 100644 --- a/docs/Server/classes/Herbs.md +++ b/docs/Server/classes/Herbs.md @@ -9,8 +9,44 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class Herbs { public Herbs(Player player) -private static Map seeds = new HashMap(); public static HerbData forId(int seedId) public int getSeedId() public int getHarvestId() +public int getLevelRequired() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public static HerbFieldsData forIdPosition(int x, int y) +public int getHerbIndex() +public Point[] getHerbPosition() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateHerbsStates() +public int getPlantState(int plantState) +public void doCalculations() +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeed(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvest(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/HighscoresHandler.md b/docs/Server/classes/HighscoresHandler.md index 62ed0cbae..aaa2c71b3 100644 --- a/docs/Server/classes/HighscoresHandler.md +++ b/docs/Server/classes/HighscoresHandler.md @@ -13,4 +13,5 @@ public HighscoresHandler() public String getRank(Player player, int i, String sortBy) public int compare(Client client, Client t1) public int compare(Client client, Client t1) +public int compare(Client client, Client t1) ``` diff --git a/docs/Server/classes/HolidayDrops.md b/docs/Server/classes/HolidayDrops.md index 81a55e96d..b519a162b 100644 --- a/docs/Server/classes/HolidayDrops.md +++ b/docs/Server/classes/HolidayDrops.md @@ -9,7 +9,6 @@ Holiday Drops @author Andrew (Mr Extremez) ```java public enum HolidayDrops { public static int dropAmount() -private HolidayDrops(int item, String name, boolean whichHoliday) public int getItem() public String getName() public boolean getHoliday() diff --git a/docs/Server/classes/Hops.md b/docs/Server/classes/Hops.md index 5848e0104..acf42936d 100644 --- a/docs/Server/classes/Hops.md +++ b/docs/Server/classes/Hops.md @@ -9,8 +9,52 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class Hops { public Hops(Player player) -private static Map seeds = new HashMap(); public static HopsData forId(int seedId) public int getSeedId() public int getHarvestId() +public int getSeedAmount() +public int getLevelRequired() +public int[] getPaymentToWatch() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public static HopsFieldsData forId(int npcId) +public static HopsFieldsData forIdPosition(int x, int y) +public int getHopsIndex() +public Point[] getHopsPosition() +public int getNpcId() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateHopsStates() +public int getPlantState(int plantState) +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean waterPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeed(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvest(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/HostBlacklist.md b/docs/Server/classes/HostBlacklist.md index a70afb5d6..e0e1df65b 100644 --- a/docs/Server/classes/HostBlacklist.md +++ b/docs/Server/classes/HostBlacklist.md @@ -8,7 +8,6 @@ Host Blacklist helper class. ```java public class HostBlacklist { -private static List blockedHostnames = new ArrayList(); public static List getBlockedHostnames() public static boolean isBlocked(String host) public static void loadBlacklist() diff --git a/docs/Server/classes/HttpChannelInitializer.md b/docs/Server/classes/HttpChannelInitializer.md index 33cbdf587..0867907f1 100644 --- a/docs/Server/classes/HttpChannelInitializer.md +++ b/docs/Server/classes/HttpChannelInitializer.md @@ -9,5 +9,4 @@ A {@link ChannelInitializer} for the HTTP protocol. @author Graham ```java public final class HttpChannelInitializer extends ChannelInitializer { public HttpChannelInitializer(ChannelInboundHandlerAdapter handler) -protected void initChannel(SocketChannel ch) throws Exception ``` diff --git a/docs/Server/classes/HttpRequestWorker.md b/docs/Server/classes/HttpRequestWorker.md index ca446558f..e6d94dcbc 100644 --- a/docs/Server/classes/HttpRequestWorker.md +++ b/docs/Server/classes/HttpRequestWorker.md @@ -8,9 +8,5 @@ A worker which services HTTP requests. @author Graham ```java public final class HttpRequestWorker extends RequestWorker { -private static final Path WWW_DIRECTORY = Paths.get("data/www"); public HttpRequestWorker(UpdateDispatcher dispatcher, IndexedFileSystem fs) -private static ByteBuf createErrorPage(HttpResponseStatus status, String description) -private static String getMimeType(String name) -protected ChannelRequest nextRequest(UpdateDispatcher dispatcher) throws InterruptedException ``` diff --git a/docs/Server/classes/IndexedFileSystem.md b/docs/Server/classes/IndexedFileSystem.md index 8eb5b8e92..ecb6bfa59 100644 --- a/docs/Server/classes/IndexedFileSystem.md +++ b/docs/Server/classes/IndexedFileSystem.md @@ -8,9 +8,12 @@ A file system based on top of the operating system's file system. It consists of ```java public final class IndexedFileSystem implements Closeable { -private final Map cache = new HashMap<>(FileSystemConstants.ARCHIVE_COUNT); public IndexedFileSystem(Path base, boolean readOnly) throws FileNotFoundException public void close() throws IOException public Archive getArchive(int type, int file) throws IOException public ByteBuffer getCrcTable() throws IOException +public int[] getCrcs() throws IOException +public ByteBuffer getFile(FileDescriptor descriptor) throws IOException +public ByteBuffer getFile(int type, int file) throws IOException +public boolean isReadOnly() ``` diff --git a/docs/Server/classes/Inventory.md b/docs/Server/classes/Inventory.md index 42d761bde..0fcd15259 100644 --- a/docs/Server/classes/Inventory.md +++ b/docs/Server/classes/Inventory.md @@ -13,4 +13,20 @@ public void removeItem(Item i) public void addItemToSlot(Item i, int slot) public int get(int slot) public void update() +public boolean contains(int id) +public boolean contains(Item item) +public boolean contains(int id, int amount) +public Inventory getItemContainer() +public void addItem(Item item) +public int getItemAmount(int id) +public void replace(int item, int newItem) +public int getCount(int i) +public void set(int slot, Item item) +public int freeSlots() +public void add(int id) +public boolean add(int id, int amount) +public boolean canAddItem(Item item) +public void addItem(Item item, boolean drop) +public boolean playerHasItem(int item) +public void removeItemSlot(Item item, int slot) ``` diff --git a/docs/Server/classes/IsaacRandom.md b/docs/Server/classes/IsaacRandom.md index 795f04865..e71825dbd 100644 --- a/docs/Server/classes/IsaacRandom.md +++ b/docs/Server/classes/IsaacRandom.md @@ -9,7 +9,5 @@ Defined in [`2006Scape Server/src/main/java/org/apollo/util/security/IsaacRandom ```java * This class has been changed to be more conformant to Java and javadoc conventions. public IsaacRandom(int[] seed) -private void isaac() -private void init() public int nextInt() ``` diff --git a/docs/Server/classes/Item.md b/docs/Server/classes/Item.md index 9fccfe51a..bb0fb8ce1 100644 --- a/docs/Server/classes/Item.md +++ b/docs/Server/classes/Item.md @@ -13,4 +13,7 @@ public void setCount(int count) public Item(int id, int count) public Item(int id, int count, int timer) public int getId() +public int getCount() +public String toString() +public boolean equals(Item item) ``` diff --git a/docs/Server/classes/ItemAssistant.md b/docs/Server/classes/ItemAssistant.md index b63c61089..716911d22 100644 --- a/docs/Server/classes/ItemAssistant.md +++ b/docs/Server/classes/ItemAssistant.md @@ -9,8 +9,74 @@ Item Assistant helper class. ```java public class ItemAssistant { public ItemAssistant(Player player2) -private static int COMMON = Misc.random(5), UNCOMMON = Misc.random(25), -private static final int[][] CASKET = { { 995, Misc.random(3000), COMMON }, public void addCasketRewards(int itemId) public void updateInventory() +public void destroyInterface(int itemId) +public void destroyItem(int itemId) +public void dropItem(int itemId) +public void addOrDropItem(int item, int amount) +public boolean hasFreeSlots(int slots) +public void replaceItem(int itemToReplace, int replaceWith) +public void replaceItem(int itemToReplace, int replaceWith, int amount) +public static int getTotalAmountEquipment(Client c) +public static int getTotalAmountItems(Client c) +public static int getTotalWealthCarrying(Client c) +public static String getTotalAmount(Client c, int j) +public boolean playerHasEquipped(int itemID) +public boolean playerHasEquipped(int slot, int itemID) +public void addItemToBank(int itemId, int amount) +public void removeItemFromBank(int itemId, int amount) +public void resetItems(int WriteFrame) +public int getItemAmount(int itemID) +public int itemAmount(int itemID) +public void writeBonus() +public int getTotalCount(int itemID) +public int getBankItemCount() +public void keepItem(int keepItem, boolean deleteItem) +public void resetKeepItems() +public void deleteAllItems() +public void clearBank() +public void dropAllItems() +public int getUntradePrice(int item) +public boolean specialCase(int itemId) +public boolean tradeable(int itemId) +public boolean addItem(int item, int amount) +public void resetBonus() +public void getBonus() +public void sendWeapon(int weapon, String weaponName) +public void getRequirements(String itemName, int itemId) +public boolean is2handed(String itemName, int itemId) +public void addSpecialBar(int weapon) +public void specialAmount(int weapon, double specAmount, int barId) +public void updateSpecialBar() +public boolean wearItem(int wearID, int slot) +public void wearItem(int wearID, int wearAmount, int targetSlot) +public void updateSlot(int slot) +public void removeItem(int slot) +public void removeItem(int wearID, int slot) +public void rearrangeBank() +public void resetBank() +public void resetTempItems() +public boolean bankItem(int itemID, int fromSlot, int amount) +public int freeBankSlots() +public int getBankQuantity(int itemID) +public void fromBank(int itemID, int fromSlot, int amount) +public void setEquipment(int wearID, int amount, int targetSlot) +public void moveItems(int from, int to, int moveWindow, boolean insertMode) +public void swapBankItem(int from, int to) +public void deleteEquipment(int i, int j) +public void deleteItem(int id, int amount) +public void deleteItem(int id, int slot, int amount) +public void deleteArrow() +public void deleteEquipment() +public void dropArrowNpc() +public void dropArrowPlayer() +public void removeAllItems() +public int freeSlots() +public int freeSlots(int itemID, int amount) +public int findItem(int id, int[] items, int[] amounts) +public int getItemSlot(int ItemID) +public boolean playerHasItem(int itemID, int amt, int slot) +public boolean playerHasItem(int itemID) +public boolean playerHasItem(int itemID, int amt) ``` diff --git a/docs/Server/classes/ItemData.md b/docs/Server/classes/ItemData.md index e1c6a522f..13c277e8f 100644 --- a/docs/Server/classes/ItemData.md +++ b/docs/Server/classes/ItemData.md @@ -8,7 +8,6 @@ Item Data helper class. ```java public class ItemData { -private static String[] fullmask = { "full helm (t)", "full helm (g)", "full helm", "mask", "Veracs helm", public static boolean isFullBody(int itemId) public static boolean isFullHelm(int itemId) public static boolean isFullMask(int itemId) diff --git a/docs/Server/classes/ItemDefinition.md b/docs/Server/classes/ItemDefinition.md index 6aeb6e87a..c2f13e968 100644 --- a/docs/Server/classes/ItemDefinition.md +++ b/docs/Server/classes/ItemDefinition.md @@ -8,9 +8,34 @@ Represents a type of Item. @author Graham ```java public final class ItemDefinition { -private static final BiMap notes = HashBiMap.create(); -private static final BiMap notesInverse = notes.inverse(); public static int count() public static ItemDefinition[] getDefinitions() public static void init(ItemDefinition[] definitions) +public static int itemToNote(int id) +public static ItemDefinition lookup(int id) +public static int noteToItem(int id) +public ItemDefinition(int id) +public String getDescription() +public String getGroundAction(int id) +public int getId() +public String getInventoryAction(int id) +public String getName() +public int getNoteGraphicId() +public int getNoteInfoId() +public int getTeam() +public int getValue() +public boolean isMembersOnly() +public boolean isNote() +public boolean isStackable() +public void setDescription(String description) +public void setGroundAction(int id, String action) +public void setInventoryAction(int id, String action) +public void setMembersOnly(boolean members) +public void setName(String name) +public void setNoteGraphicId(int noteGraphicId) +public void setNoteInfoId(int noteInfoId) +public void setStackable(boolean stackable) +public void setTeam(int team) +public void setValue(int value) +public void toNote() ``` diff --git a/docs/Server/classes/ItemDefinitionDecoder.md b/docs/Server/classes/ItemDefinitionDecoder.md index 56e4af29d..3f9a691fe 100644 --- a/docs/Server/classes/ItemDefinitionDecoder.md +++ b/docs/Server/classes/ItemDefinitionDecoder.md @@ -10,5 +10,4 @@ Decodes item data from the {@code obj.dat} file into {@link ItemDefinition}s. @ public final class ItemDefinitionDecoder implements Runnable { public ItemDefinitionDecoder(IndexedFileSystem fs) public void run() -private ItemDefinition decode(int id, ByteBuffer buffer) ``` diff --git a/docs/Server/classes/ItemDefinitions.md b/docs/Server/classes/ItemDefinitions.md index 57f43b04d..21ee69848 100644 --- a/docs/Server/classes/ItemDefinitions.md +++ b/docs/Server/classes/ItemDefinitions.md @@ -8,9 +8,8 @@ Loads the bonuses and weights from a json file. @author Advocatus ```java public class ItemDefinitions { -private static Map defintions = new HashMap<>(); public static int[] getBonus(int id) public static double getWeight(int id) public static void load() -private Definition(ItemData item) +public int[] getBonuses() ``` diff --git a/docs/Server/classes/ItemHandler.md b/docs/Server/classes/ItemHandler.md index 8be469487..999dfaaa3 100644 --- a/docs/Server/classes/ItemHandler.md +++ b/docs/Server/classes/ItemHandler.md @@ -13,4 +13,11 @@ public ItemHandler() public void addItem(GroundItem item) public void removeItem(GroundItem item) public int itemAmount(String name, int itemId, int itemX, int itemY) +public boolean itemExists(int itemId, int itemX, int itemY) +public void moveItem(GroundItem item, int itemX, int itemY) +public void reloadItems(Player c) +public void process() +public void createGroundItem(Player c, int itemId, int itemX, int itemY, int itemAmount, int playerId) +public void createGlobalItem(GroundItem i) +public void removeGroundItem(Player c, int itemId, int itemX, int itemY, boolean add) ``` diff --git a/docs/Server/classes/JagGrabChannelInitializer.md b/docs/Server/classes/JagGrabChannelInitializer.md index 81a4e54ba..533e07146 100644 --- a/docs/Server/classes/JagGrabChannelInitializer.md +++ b/docs/Server/classes/JagGrabChannelInitializer.md @@ -8,7 +8,6 @@ A {@link ChannelInitializer} for the JAGGRAB protocol. @author Graham ```java public final class JagGrabChannelInitializer extends ChannelInitializer { -private static final ByteBuf DOUBLE_LINE_FEED_DELIMITER = Unpooled.buffer(2); public JagGrabChannelInitializer(ChannelInboundHandlerAdapter handler) public void initChannel(SocketChannel ch) throws Exception ``` diff --git a/docs/Server/classes/JagGrabRequestDecoder.md b/docs/Server/classes/JagGrabRequestDecoder.md index 531a039f4..991f1da71 100644 --- a/docs/Server/classes/JagGrabRequestDecoder.md +++ b/docs/Server/classes/JagGrabRequestDecoder.md @@ -8,5 +8,4 @@ A {@link MessageToMessageDecoder} for the JAGGRAB protocol. @author Graham ```java public final class JagGrabRequestDecoder extends MessageToMessageDecoder { -protected void decode(ChannelHandlerContext ctx, String request, List out) ``` diff --git a/docs/Server/classes/JagGrabRequestWorker.md b/docs/Server/classes/JagGrabRequestWorker.md index f46751c9a..e2e1a5968 100644 --- a/docs/Server/classes/JagGrabRequestWorker.md +++ b/docs/Server/classes/JagGrabRequestWorker.md @@ -9,6 +9,4 @@ A worker which services JAGGRAB requests. @author Graham ```java public final class JagGrabRequestWorker extends RequestWorker { public JagGrabRequestWorker(UpdateDispatcher dispatcher, IndexedFileSystem fs) -protected ChannelRequest nextRequest(UpdateDispatcher dispatcher) throws InterruptedException -protected void service(ResourceProvider provider, Channel channel, JagGrabRequest request) throws IOException ``` diff --git a/docs/Server/classes/JagGrabResponseEncoder.md b/docs/Server/classes/JagGrabResponseEncoder.md index b13d7625c..3c534050d 100644 --- a/docs/Server/classes/JagGrabResponseEncoder.md +++ b/docs/Server/classes/JagGrabResponseEncoder.md @@ -8,5 +8,4 @@ A {@link MessageToMessageEncoder} for the JAGGRAB protocol. @author Graham ```java public final class JagGrabResponseEncoder extends MessageToMessageEncoder { -protected void encode(ChannelHandlerContext ctx, JagGrabResponse response, List out) ``` diff --git a/docs/Server/classes/LanguageUtil.md b/docs/Server/classes/LanguageUtil.md index d62773f33..b5a0b69cf 100644 --- a/docs/Server/classes/LanguageUtil.md +++ b/docs/Server/classes/LanguageUtil.md @@ -9,6 +9,4 @@ Contains language-related utility methods. @author Graham @author Major ```java public final class LanguageUtil { public static String getIndefiniteArticle(String string) -private static boolean allUpperCase(String string) -private LanguageUtil() ``` diff --git a/docs/Server/classes/LightSources.md b/docs/Server/classes/LightSources.md index 12378c825..166d7a2f8 100644 --- a/docs/Server/classes/LightSources.md +++ b/docs/Server/classes/LightSources.md @@ -13,4 +13,6 @@ public static void brightness1(Player player) public static void brightness2(Player player) public static void brightness3(Player player) public static void brightness4(Player player) +public static void setBrightness(Player c) +public static boolean playerHasLightSource(Player client) ``` diff --git a/docs/Server/classes/LogCutting.md b/docs/Server/classes/LogCutting.md index e0b913657..7db52bd4a 100644 --- a/docs/Server/classes/LogCutting.md +++ b/docs/Server/classes/LogCutting.md @@ -13,4 +13,8 @@ public static void cutLog(final Player player, final int product, final int leve public void execute(CycleEventContainer container) public void stop() public static void handleClick(Player player, int buttonId) +public static void wolfBoneArrow(Player c) +public static void flightedArrow(Player c) {// to do +public static void ogreArrow(Player c) +public static void makeShafts(Player c) ``` diff --git a/docs/Server/classes/LogData.md b/docs/Server/classes/LogData.md index d69ac74d4..cb1421c7b 100644 --- a/docs/Server/classes/LogData.md +++ b/docs/Server/classes/LogData.md @@ -8,7 +8,6 @@ Log Data helper class. ```java public enum LogData { -private LogData(int logId, int level, double xp) public int getLogId() public int getLevel() public double getXp() diff --git a/docs/Server/classes/LoginConstants.md b/docs/Server/classes/LoginConstants.md index 5a11571fb..d03b93971 100644 --- a/docs/Server/classes/LoginConstants.md +++ b/docs/Server/classes/LoginConstants.md @@ -8,5 +8,4 @@ Holds login-related constants. @author Graham ```java public final class LoginConstants { -private LoginConstants() ``` diff --git a/docs/Server/classes/LoginDecoder.md b/docs/Server/classes/LoginDecoder.md index 560fbc70e..a8e27a340 100644 --- a/docs/Server/classes/LoginDecoder.md +++ b/docs/Server/classes/LoginDecoder.md @@ -8,9 +8,5 @@ A {@link StatefulFrameDecoder} which decodes the login request frames. @author ```java public final class LoginDecoder extends StatefulFrameDecoder { -private static final Logger logger = Logger.getLogger(LoginDecoder.class.getName()); -private static final SecureRandom RANDOM = new SecureRandom(); public LoginDecoder() -protected void decode(ChannelHandlerContext ctx, ByteBuf in, List out, LoginDecoderState state) -private void decodeHandshake(ChannelHandlerContext ctx, ByteBuf buffer, List out) ``` diff --git a/docs/Server/classes/LoginEncoder.md b/docs/Server/classes/LoginEncoder.md index 054ca4f18..92794c729 100644 --- a/docs/Server/classes/LoginEncoder.md +++ b/docs/Server/classes/LoginEncoder.md @@ -9,5 +9,4 @@ A {@link MessageToByteEncoder} which encodes login response messages. @author G ```java public final class LoginEncoder extends MessageToByteEncoder { public LoginEncoder() -protected void encode(ChannelHandlerContext ctx, LoginResponse response, ByteBuf out) ``` diff --git a/docs/Server/classes/LoginRequest.md b/docs/Server/classes/LoginRequest.md index 856bae50a..00203cc72 100644 --- a/docs/Server/classes/LoginRequest.md +++ b/docs/Server/classes/LoginRequest.md @@ -13,4 +13,7 @@ public int[] getArchiveCrcs() public int getClientVersion() public PlayerCredentials getCredentials() public IsaacRandomPair getRandomPair() +public int getReleaseNumber() +public boolean isLowMemory() +public boolean isReconnecting() ``` diff --git a/docs/Server/classes/LoginSession.md b/docs/Server/classes/LoginSession.md index 0d000f934..eb6872094 100644 --- a/docs/Server/classes/LoginSession.md +++ b/docs/Server/classes/LoginSession.md @@ -11,5 +11,4 @@ public final class LoginSession extends Session { public LoginSession(Channel channel) public void destroy() public void messageReceived(Object message) throws Exception -private void handleLoginRequest(LoginRequest request) throws IOException ``` diff --git a/docs/Server/classes/MageTrainingArena.md b/docs/Server/classes/MageTrainingArena.md index 63a361d00..d2c00d651 100644 --- a/docs/Server/classes/MageTrainingArena.md +++ b/docs/Server/classes/MageTrainingArena.md @@ -13,4 +13,10 @@ public MageTrainingArena(Player c) public void openShop() public int getTelekineticPointValue(int itemId) public int getAlchemyPointValue(int itemId) +public int getEnchantmentPointValue(int itemId) +public int getGraveyardPointValue(int itemId) +public void sendItemValue(int itemId) +public void buyItem(int itemId) +public void enchantItem(int itemID, int spellID) +public void alchItem(int itemID, int spellID) ``` diff --git a/docs/Server/classes/MagicData.md b/docs/Server/classes/MagicData.md index 404c3ed5c..20faa2207 100644 --- a/docs/Server/classes/MagicData.md +++ b/docs/Server/classes/MagicData.md @@ -13,4 +13,9 @@ public static boolean multis(Player c) public static int getFreezeTime(Player c) public static int getStartHeight(Player c) public static int getEndHeight(Player c) +public static int getStartDelay(Player c) +public static boolean godSpells(Player c) +public static int getEndGfxHeight(Player c) +public static int getStartGfxHeight(Player c) +public static boolean fullVoidMage(Player c) ``` diff --git a/docs/Server/classes/MapConstants.md b/docs/Server/classes/MapConstants.md index 67d720f52..4a81813b1 100644 --- a/docs/Server/classes/MapConstants.md +++ b/docs/Server/classes/MapConstants.md @@ -8,5 +8,4 @@ Contains {@link MapFile}-related constants. @author Major ```java public final class MapConstants { -private MapConstants() ``` diff --git a/docs/Server/classes/MapFileDecoder.md b/docs/Server/classes/MapFileDecoder.md index 15a4e0176..cf3226d5a 100644 --- a/docs/Server/classes/MapFileDecoder.md +++ b/docs/Server/classes/MapFileDecoder.md @@ -11,6 +11,4 @@ public class MapFileDecoder { public static MapFileDecoder create(IndexedFileSystem fs, MapIndex index) throws IOException public MapFileDecoder(ByteBuffer buffer) public MapFile decode() -private MapPlane decodePlane(MapPlane[] planes, int level) -private Tile decodeTile(MapPlane[] planes, int level, int x, int z) ``` diff --git a/docs/Server/classes/MapIndex.md b/docs/Server/classes/MapIndex.md index 3b683d188..5709fd309 100644 --- a/docs/Server/classes/MapIndex.md +++ b/docs/Server/classes/MapIndex.md @@ -13,4 +13,8 @@ public static Map getIndices() public MapIndex(int packedCoordinates, int terrain, int objects, boolean members) public int getObjectFile() public int getPackedCoordinates() +public int getMapFile() +public int getX() +public int getY() +public boolean isMembersOnly() ``` diff --git a/docs/Server/classes/MapObject.md b/docs/Server/classes/MapObject.md index 8cfdda28e..4e7d9d9e2 100644 --- a/docs/Server/classes/MapObject.md +++ b/docs/Server/classes/MapObject.md @@ -13,4 +13,8 @@ public MapObject(int id, int x, int y, int height, int type, int orientation) public int getId() public int getHeight() public int getLocalX() +public int getLocalY() +public int getOrientation() +public int getPackedCoordinates() +public int getType() ``` diff --git a/docs/Server/classes/MapPlane.md b/docs/Server/classes/MapPlane.md index 7a8dbb4f3..ea65a5492 100644 --- a/docs/Server/classes/MapPlane.md +++ b/docs/Server/classes/MapPlane.md @@ -8,9 +8,9 @@ A plane of a map, which is a distinct height level. @author Major ```java public final class MapPlane { -private static T[][] clone(T[][] array) public MapPlane(int level, Tile[][] tiles) public int getLevel() public int getSize() public Tile getTile(int x, int z) +public Stream getTiles() ``` diff --git a/docs/Server/classes/MeleeData.md b/docs/Server/classes/MeleeData.md index 92f2d04df..c45c1f697 100644 --- a/docs/Server/classes/MeleeData.md +++ b/docs/Server/classes/MeleeData.md @@ -13,4 +13,9 @@ public static int calculateMeleeAttack(Player c) public static int bestMeleeAtk(Player c) public static int calculateMeleeDefence(Player c) public static int bestMeleeDef(Player c) +public static int getAttackDelay(Player c) +public static void getPlayerAnimIndex(Player c) +public static int getWeaponAnimation(Player c) +public static int getBlockEmote(Player c) +public static int getHitDelay(Player c) ``` diff --git a/docs/Server/classes/Mining.md b/docs/Server/classes/Mining.md index ae8bb5135..6506b887e 100644 --- a/docs/Server/classes/Mining.md +++ b/docs/Server/classes/Mining.md @@ -11,6 +11,30 @@ public class Mining { public boolean giveGem(Player player) public void obtainGem(Player player) public static int getRandom() -private rockData(final int[] objectId, final int levelReq, final int xp, final int mineTimer, final int respawnTimer, final int... oreIds) public int getObject(final int object) +public static rockData getRock(final int object) +public int getRequiredLevel() +public int getXp() +public int getTimer() +public int getRespawnTimer() +public int[] getOreIds() +public int getOre(int playerLevel) +public void repeatAnimation(final Player c) +public void execute(CycleEventContainer container) +public void stop() +public void startMining(final Player player, final int objectID, final int objectX, final int objectY, final int type) +public void execute(CycleEventContainer container) +public void stop() +public static void resetMining(Player player) +public int getTimer(rockData rock, int pick, int level) +public void mineRock(int respawnTime, int x, int y, int type, int i) +public static void prospectRock(final Player player, final String itemName) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public static void prospectNothing(final Player c) +public void execute(CycleEventContainer container) +public void stop() +public static boolean rockExists(int rockID) ``` diff --git a/docs/Server/classes/Misc.md b/docs/Server/classes/Misc.md index 8989b6507..4c92f3593 100644 --- a/docs/Server/classes/Misc.md +++ b/docs/Server/classes/Misc.md @@ -13,4 +13,88 @@ public static int random(final float range) public static int randomMinusOne(int range) public static double distance(int x1, int y1, int x2, int y2 ) public static boolean goodDistance(int objectX, int objectY, int playerX, int playerY, int distance) +public static String longToReportPlayerName(long l) +public static int random3(int range) +public static int randomNumber(int range) +public static String longToPlayerName(long l) +public static String longToPlayerName2(long l) +public static String format(final int num) +public static String formatValue(int value) +public static String format(final long num) +public static String formatPrice(final int amount) +public static double roundDoubleToNearestOneDecimalPlace(double number) +public static double roundDoubleToNearestTwoDecimalPlaces(double number) +public static double getDoubleRoundedUp(double doubleNumber) +public static double getDoubleRoundedDown(double doubleNumber) +public static String formatRunescapeStyle(long num) +public static String formatText(String s) +public static String formatTextUnderscore(String s) +public static String optimizeTextNew(String text) +public static String getTotalAmount(int j) +public static String insertCommasToNumber(String number) +public static String ucFirst(String str) +public static String formatNumber(long number) +public static String Hex(byte data[]) +public static String Hex(byte data[], int offset, int len) +public static int random2(int range) +public static int random(int range) +public static int random(int min, int max) +public static int randomArrayItem(int[] arr) +public static int randomArrayListItem(ArrayList arr) +public static long playerNameToInt64(String s) +public static String textUnpack(byte packedData[], int size) +public static String optimizeText(String text) +public static void textPack(Stream inStream, String text) +public static int[] delta(int x1, int y1, int x2, int y2) +public static int directionFromDelta(int x, int y) +public static int direction(int srcX, int srcY, int x, int y) +public static String capitalize(String s) +public static int toCyclesOrDefault(long time, int def, TimeUnit unit) +public static > List> sortEntries(Map map) +public static Map sortByComparator(Map unsortMap, final boolean ascending) +public static List jsonArrayToList(Path path, Class clazz) +public static String kOrMil(int amount) +public static int[] convertRollRangeStringToIntArray(String input) +public static final Random RANDOM = new Random(); +public static boolean percentageChance(int chance) +public static String getFractionFromPercentage(float percentage) +public static int getDenominatorFromPercentage(float percentage) +public static String getCurrentServerTime() +public static String getCurrentServerDateTime() +public static String getFormattedPlayTime(Player player, long creationTime) +public static String getTimePlayed(long totalPlayTime) +public static String getHoursPlayed(long totalPlayTime) +public static String asMinutesLeft(int ticksLeft) +public static String asSeconds(int ticksLeft) +public static int getMinutesPassed(long t) +public static String getStackTrace() +public static float getPercentageFromDecimal(float decimal) +public static float getPercentageFromDenominator(float denominator) +public static float getDecimalFromFraction(int numerator, int denominator) +public static float getDecimalFromDenominator(int denominator) +public static String getDate() +public static String getSimpleDate() +public static String pluralOrNot(String word, int count) +public static float ticksToSeconds(int tick) +public static float ticksToMinutes(int tick) +public static float ticksToHours(int tick) +public static String convertLongToDateTime(long time) +public static String convertLongToTime(long time) +public static String convertLongToDate(long time) +public static String convertLongToDuration(long time) +public static String convertLongToShortDuration(long time, boolean useSeconds) +public static String convertSecondsToShortDuration(long time, boolean useSeconds) +public static String convertSecondsToDuration(long time, boolean showDaysAndHours) +public static int getMinutesElapsed(int minute, int hour, int day, int year) +public static int getDayOfYear() +public static int getYear() +public static int getElapsed(int day, int year) +public static boolean isWeekend() +public static int getTicks(int seconds) +public static int getSeconds(int ticks) +public static String getServerUptime(long serverStartTime) +public static double roundOneDecimal(double number_to_format) +public static double round(double number_to_format) +public static boolean rollDie(int dieSides, int chance) +public static String capitalizeJustFirst(String str) ``` diff --git a/docs/Server/classes/NPCDefinition.md b/docs/Server/classes/NPCDefinition.md index 430984399..69c588d9b 100644 --- a/docs/Server/classes/NPCDefinition.md +++ b/docs/Server/classes/NPCDefinition.md @@ -1,12 +1,34 @@ -# NpcDefinition +# NPCDefinition -Data holder describing a non-player character. Definitions are loaded from -`npcDefinitions.json` on startup and cached for quick lookup via -`NPCDefinition.forId(int)`. +Package `com.rs2.game.npcs`. -Source: [NPCDefinition.java](../../2006Scape%20Server/src/main/java/com/rs2/game/npcs/NPCDefinition.java) +Defined in [`2006Scape Server/src/main/java/com/rs2/game/npcs/NPCDefinition.java`](2006Scape Server/src/main/java/com/rs2/game/npcs/NPCDefinition.java). + +NPCDefinition helper class. ```java -NPCDefinition goblin = NPCDefinition.forId(1); -System.out.println(goblin.getName()); +public class NPCDefinition { +public static void init() throws IOException +public static NPCDefinition forId(int id) +public int getId() +public String getName() +public String getExamine() +public int getRespawn() +public int getCombat() +public int getHitpoints() +public int getMaxHit() +public int getSize() +public boolean isAggressive() +public boolean retreats() +public boolean isPoisonous() +public static NPCDefinition produceDefinition(int id) +public int getAttackSpeed() +public int getAttackAnimation() +public int getDefenceAnimation() +public int getDeathAnimation() +public boolean isAttackable() +public int getAttackBonus() +public int getDefenceRange() +public int getDefenceMelee() +public int getDefenceMage() ``` diff --git a/docs/Server/classes/NameUtil.md b/docs/Server/classes/NameUtil.md index 5eaefa56e..1c419235c 100644 --- a/docs/Server/classes/NameUtil.md +++ b/docs/Server/classes/NameUtil.md @@ -8,9 +8,6 @@ Contains name-related utility methods. @author Graham ```java public final class NameUtil { -private static final long FIRST_VALID_NAME = encodeBase37(""); -private static final long LAST_VALID_NAME = encodeBase37("999999999999"); public static String decodeBase37(long value) public static long encodeBase37(String string) -private NameUtil() ``` diff --git a/docs/Server/classes/Npc.md b/docs/Server/classes/Npc.md index 4c993856f..208541bff 100644 --- a/docs/Server/classes/Npc.md +++ b/docs/Server/classes/Npc.md @@ -13,4 +13,36 @@ public void requestTransform(int id) public String name() public void shearSheep(Player player, int itemNeeded, int itemGiven, int animation, final int currentId, final int newId, int transformTime) public void execute(CycleEventContainer container) +public void stop() +public void appendTransformUpdate(Stream str) +public void updateNPCMovement(Stream str) +public void forceChat(String text) +public void appendMask80Update(Stream str) +public void gfx100(int gfx) +public void gfx0(int gfx) +public void appendAnimUpdate(Stream str) +public int startAnimation(int anim, int npcId) +public void turnNpc(int i, int j) +public int getNextWalkingDirection2() +public void getRandomAndHomeNPCWalking(int i) +public void appendFaceEntity(Stream str) +public void facePlayer(Player player) +public void appendFaceToUpdate(Stream str) +public void appendNPCUpdateBlock(Stream str) +public void clearUpdateFlags() +public int getNextWalkingDirection() +public void getNextNPCMovement(int i) +public void appendHitUpdate(Stream str) +public void appendHitUpdate2(Stream str) +public void handleHitMask(int damage) +public int getX() +public int getY() +public int getLastX() +public int getLastY() +public void setAbsX(int absX) +public void setAbsY(int absY) +public void deleteNPC(Npc npc) +public boolean inLesserNpc() +public boolean inMulti() +public boolean inWild() {// beg, end, beg, end, beg, end, beg, end ``` diff --git a/docs/Server/classes/NpcCombat.md b/docs/Server/classes/NpcCombat.md index 653dd9478..cbfb4d047 100644 --- a/docs/Server/classes/NpcCombat.md +++ b/docs/Server/classes/NpcCombat.md @@ -13,4 +13,5 @@ public static void multiAttackGfx(int i, int gfx) public static void attackPlayer(Player c, int i) public static void loadSpell2(int i) public static void loadSpell(Player c, int i) +public static void registerNpcHit(int i) ``` diff --git a/docs/Server/classes/NpcData.md b/docs/Server/classes/NpcData.md index ad42a67f0..731dc4663 100644 --- a/docs/Server/classes/NpcData.md +++ b/docs/Server/classes/NpcData.md @@ -13,4 +13,14 @@ public static boolean onlyMage(int npcType) public static boolean cantAttack(int npcType) public static boolean dontGiveXp(int npcType) public static int getNpcKillerId(int npcId) +public static int getCloseRandomPlayer(int i) +public static void startAnimation(int animId, int i) +public static void handleClipping(int i) +public static int getNpcDelay(int i) +public static int getHitDelay(int i) +public static int getRespawnTime(int i) +public static int distanceRequired(int i) +public static boolean goodDistanceNpc(int i, int x2, int y2, int distance) +public static boolean checkClip(Npc n) +public static boolean inNpc(int i, int x2, int y2) ``` diff --git a/docs/Server/classes/NpcDefinition.md b/docs/Server/classes/NpcDefinition.md index 5b232df19..04e4a198a 100644 --- a/docs/Server/classes/NpcDefinition.md +++ b/docs/Server/classes/NpcDefinition.md @@ -1,6 +1,5 @@ # NpcDefinition - Package `org.apollo.cache.def`. Defined in [`2006Scape Server/src/main/java/org/apollo/cache/def/NpcDefinition.java`](2006Scape Server/src/main/java/org/apollo/cache/def/NpcDefinition.java). @@ -14,5 +13,31 @@ public static NpcDefinition[] getDefinitions() public static void init(NpcDefinition[] definitions) public static NpcDefinition lookup(int id) public NpcDefinition(int id) - +public int getCombatLevel() +public String getDescription() +public int getId() +public String getInteraction(int slot) +public String[] getInteractions() +public String getName() +public int getSize() +public int getStandAnimation() +public int getWalkAnimation() +public int getWalkBackAnimation() +public int getWalkLeftAnimation() +public int getWalkRightAnimation() +public boolean hasCombatLevel() +public boolean hasInteraction(int slot) +public boolean hasStandAnimation() +public boolean hasWalkAnimation() +public boolean hasWalkBackAnimation() +public boolean hasWalkLeftAnimation() +public boolean hasWalkRightAnimation() +public void setCombatLevel(int combatLevel) +public void setDescription(String description) +public void setInteraction(int slot, String interaction) +public void setName(String name) +public void setSize(int size) +public void setStandAnimation(int standAnim) +public void setWalkAnimation(int walkAnim) +public void setWalkAnimations(int walkAnim, int walkBackAnim, int walkLeftAnim, int walkRightAnim) ``` diff --git a/docs/Server/classes/NpcDefinitionDecoder.md b/docs/Server/classes/NpcDefinitionDecoder.md index 444652134..765a27b45 100644 --- a/docs/Server/classes/NpcDefinitionDecoder.md +++ b/docs/Server/classes/NpcDefinitionDecoder.md @@ -10,6 +10,4 @@ Decodes npc data from the {@code npc.dat} file into {@link NpcDefinition}s. @au public final class NpcDefinitionDecoder implements Runnable { public NpcDefinitionDecoder(IndexedFileSystem fs) public void run() -private NpcDefinition decode(int id, ByteBuffer buffer) -private int wrap(int value) ``` diff --git a/docs/Server/classes/NpcEmotes.md b/docs/Server/classes/NpcEmotes.md index a71247f08..2ad8fbb03 100644 --- a/docs/Server/classes/NpcEmotes.md +++ b/docs/Server/classes/NpcEmotes.md @@ -8,9 +8,7 @@ Npc Emotes @author Andrew (Mr Extremez) ```java public enum NpcEmotes { -private NpcEmotes(int[] npcId, int attackAnim, int blockAnim, int deadAnim) -private int[] getNpcId() -private int getAttack() -private int getBlock() -private int getDead() +public static int getAttackEmote(int i) +public static int getBlockEmote(int i) +public static int getDeadEmote(Player player, int i) ``` diff --git a/docs/Server/classes/NpcHandler.md b/docs/Server/classes/NpcHandler.md index feed8fb3e..b2973c9ba 100644 --- a/docs/Server/classes/NpcHandler.md +++ b/docs/Server/classes/NpcHandler.md @@ -13,4 +13,44 @@ public void execute(CycleEventContainer container) public void stop() public void spawnFirstForm(Player c, final int i) public void execute(CycleEventContainer container) +public void stop() +public void catchRat(final int npcIndex) +public void execute(CycleEventContainer container) +public void stop() +public NpcHandler() +public static boolean isUndead(int index) +public boolean switchesAttackers(int i) { // This seems unused, that's probably not good +public int getClosePlayer(Player c, int i) +public void spawnNpc2(int npcType, int x, int y, int heightLevel, int WalkingType, int HP, int maxHit, int attack, int defence, boolean attackPlayer) +public void newNPCList(int npcType, String npcName, int combat, int HP) +public int getKillerId(int playerId) +public void process() +public boolean getsPulled(Player c, int i) +public static boolean multiAttacks(int i) +public static void handleClipping(int i) +public void dropItems(int i) +public void appendSlayerExperience(int i) +public void resetEvent(int i) +public void resetPlayersInCombat(int i) +public static int GetMove(int Place1, int Place2) +public static boolean followPlayer(int i) +public static void followPlayer(int i, Player player) +public static int distanceRequired(int i) +public static int followDistance(int i) +public static int getProjectileSpeed(int i) +public static int offset(int i) +public boolean specialCase(Player c, int i) { // responsible for npcs that +public boolean retaliates(int npcType) +public static void handleSpecialEffects(Player c, int i, int damage) +public static int getMaxHit(int i) +public static int getNpcListCombat(int npcId) +public void loadSpawnList() +public boolean writeAutoSpawn(String FileName) +public static int getNpcListHP(int npcId) +public static String getNpcListName(int npcId) +public void loadNPCList() +public boolean writeNpcListJson(String FileName) +public static boolean checkSpawn(Client player, int i) +public boolean getNpcListAggressive(int npcId) +public int getNpcSize(int npcId) ``` diff --git a/docs/Server/classes/NpcSpawn.md b/docs/Server/classes/NpcSpawn.md index 9285c11aa..89ed96744 100644 --- a/docs/Server/classes/NpcSpawn.md +++ b/docs/Server/classes/NpcSpawn.md @@ -13,4 +13,8 @@ public int getId() public int getX() public int getY() public int getHeight() +public int isWalk() +public int getMaxHit() +public int getAttack() +public int getStrength() ``` diff --git a/docs/Server/classes/ObjectDefinition.md b/docs/Server/classes/ObjectDefinition.md index 72f0ec9d8..d843d2c1a 100644 --- a/docs/Server/classes/ObjectDefinition.md +++ b/docs/Server/classes/ObjectDefinition.md @@ -13,4 +13,25 @@ public static ObjectDefinition[] getDefinitions() public static void init(ObjectDefinition[] definitions) public static ObjectDefinition lookup(int id) public ObjectDefinition(int id) +public String getDescription() +public int getId() +public int getLength() +public String[] getMenuActions() +public String getName() +public int getWidth() +public boolean isClipped() +public boolean isImpenetrable() +public boolean isInteractive() +public boolean isObstructive() +public boolean isSolid() +public void setClipped(boolean clipped) +public void setDescription(String description) +public void setImpenetrable(boolean impenetrable) +public void setInteractive(boolean interactive) +public void setLength(int length) +public void setMenuActions(String[] menuActions) +public void setName(String name) +public void setSolid(boolean solid) +public void setWidth(int width) +public void setObstructive(boolean obstructive) ``` diff --git a/docs/Server/classes/ObjectDefinitionDecoder.md b/docs/Server/classes/ObjectDefinitionDecoder.md index 5fca97a95..0ee78890c 100644 --- a/docs/Server/classes/ObjectDefinitionDecoder.md +++ b/docs/Server/classes/ObjectDefinitionDecoder.md @@ -10,5 +10,4 @@ Decodes object data from the {@code loc.dat} file into {@link ObjectDefinition}s public final class ObjectDefinitionDecoder implements Runnable { public ObjectDefinitionDecoder(IndexedFileSystem fs) public void run() -private ObjectDefinition decode(int id, ByteBuffer data) ``` diff --git a/docs/Server/classes/ObjectHandler.md b/docs/Server/classes/ObjectHandler.md index f5b1f22c1..5f7826b37 100644 --- a/docs/Server/classes/ObjectHandler.md +++ b/docs/Server/classes/ObjectHandler.md @@ -1,12 +1,33 @@ # ObjectHandler -Manages world objects such as doors, obelisks and scenery. `ObjectHandler` -creates objects for nearby players and periodically updates them as their -timers expire. +Package `com.rs2.world`. -Source: [ObjectHandler.java](../../2006Scape%20Server/src/main/java/com/rs2/world/ObjectHandler.java) +Defined in [`2006Scape Server/src/main/java/com/rs2/world/ObjectHandler.java`](2006Scape Server/src/main/java/com/rs2/world/ObjectHandler.java). + +@author Sanity ```java -// spawn a temporary object -objectHandler.createAnObject(1234, 3222, 3218, 0); +public class ObjectHandler { +public List globalObjects = new ArrayList(); +public static List mapObjects = new ArrayList(); +public static List removedObjects = new ArrayList(); +public ObjectHandler() +public Objects getObjectByPosition(int x, int y) +public void createAnObject(int id, int x, int y, int face) +public void createAnObject(Player c, int id, int x, int y) +public void createAnObject(Player player, int id, int x, int y, int h, int face) +public void createAnObject(Player player, int id, int x, int y, int h) +public void createAnObject(int id, int x, int y, int h, int face, int type) +public void createAnObject(int id, int x, int y) +public void addObject(Objects object) +public void removeObject(Objects object) +public Objects objectExists(int objectX, int objectY, int objectHeight) +public void updateObjects(Player c) +public void placeObject(Objects o) +public void removeAllObjects(Objects o) +public void process() +public boolean isObelisk(int id) +public void startObelisk(int obeliskId) +public int getObeliskIndex(int id) +public void teleportObelisk(int port) ``` diff --git a/docs/Server/classes/ObjectManager.md b/docs/Server/classes/ObjectManager.md index 0c48fcb67..5a19fe16a 100644 --- a/docs/Server/classes/ObjectManager.md +++ b/docs/Server/classes/ObjectManager.md @@ -9,8 +9,27 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/world/ObjectManager.java`](2 ```java public class ObjectManager { public ArrayList objects = new ArrayList(); -private final ArrayList toRemove = new ArrayList(); public static void objectTicks(final Player player, final int objectId, final int objectX, final int objectY, final int objectH, final int face, final int objectType, int ticks) public void execute(CycleEventContainer container) public void stop() +public static void singleGateTicks(final Player player, final int objectId, final int newObjectX, final int newObjectY, final int oldObjectX, final int oldObjectY, final int objectH, final int face, int ticks) +public void execute(CycleEventContainer container) +public void stop() +public static void doubleGateTicks(final Player player, final int objectId, final int newObjectX, final int newObjectY, final int oldObjectX, final int oldObjectY, final int oldObjectX2, final int oldObjectY2, final int objectH, final int face, int ticks) +public void execute(CycleEventContainer container) +public void stop() +public boolean objectExists(final int x, final int y) +public void process() +public void removeObject(int x, int y) +public void updateObject(Object o) +public void placeObject(Object o) +public Object getObject(int x, int y, int height) +public void loadObjects(Player c) +public void loadCustomSpawns(Player c) +public boolean isObelisk(int id) +public void startObelisk(int obeliskId) +public int getObeliskIndex(int id) +public void teleportObelisk(int port) +public boolean loadForPlayer(Object o, Player c) +public void addObject(Object o) ``` diff --git a/docs/Server/classes/Objects.md b/docs/Server/classes/Objects.md index 976d9e77a..ddf77cb12 100644 --- a/docs/Server/classes/Objects.md +++ b/docs/Server/classes/Objects.md @@ -13,4 +13,8 @@ public int getObjectX() public int getObjectY() public Objects(int id, int x, int y, int height, int face, int type, int ticks) public int[] getObjectSize() +public String toString() +public int getObjectHeight() +public int getObjectFace() +public int getObjectType() ``` diff --git a/docs/Server/classes/ObjectsActions.md b/docs/Server/classes/ObjectsActions.md index 0af704962..6f7467e31 100644 --- a/docs/Server/classes/ObjectsActions.md +++ b/docs/Server/classes/ObjectsActions.md @@ -13,4 +13,14 @@ public void firstClickObject(int objectType, int objectX, int objectY) public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void secondClickObject(int objectType, int obX, int obY) +public void thirdClickObject(int objectType, int obX, int obY) +public void fourthClickObject(int objectType, int obX, int obY) ``` diff --git a/docs/Server/classes/OnDemandRequest.md b/docs/Server/classes/OnDemandRequest.md index 7984b088b..b2090cf7e 100644 --- a/docs/Server/classes/OnDemandRequest.md +++ b/docs/Server/classes/OnDemandRequest.md @@ -9,8 +9,10 @@ Represents a single 'on-demand' request. @author Graham ```java public final class OnDemandRequest implements Comparable { public static Priority valueOf(int value) -private Priority(int value) public int compareWith(Priority other) public int toInteger() public OnDemandRequest(FileDescriptor descriptor, Priority priority) +public int compareTo(OnDemandRequest other) +public FileDescriptor getFileDescriptor() +public Priority getPriority() ``` diff --git a/docs/Server/classes/OnDemandRequestWorker.md b/docs/Server/classes/OnDemandRequestWorker.md index 4914b39d8..bed771eaf 100644 --- a/docs/Server/classes/OnDemandRequestWorker.md +++ b/docs/Server/classes/OnDemandRequestWorker.md @@ -9,6 +9,4 @@ A worker which services 'on-demand' requests. @author Graham ```java public final class OnDemandRequestWorker extends RequestWorker { public OnDemandRequestWorker(UpdateDispatcher dispatcher, IndexedFileSystem fs) -protected ChannelRequest nextRequest(UpdateDispatcher dispatcher) throws InterruptedException -protected void service(IndexedFileSystem fs, Channel channel, OnDemandRequest request) throws IOException ``` diff --git a/docs/Server/classes/OrbCharging.md b/docs/Server/classes/OrbCharging.md index 13d89bdd6..2fd7a9657 100644 --- a/docs/Server/classes/OrbCharging.md +++ b/docs/Server/classes/OrbCharging.md @@ -11,6 +11,13 @@ public class OrbCharging { public static void chargeOrbs(final Player player, final int spellId, final int objectId) public void execute(CycleEventContainer container) public void stop() -private Orb(final int[][] objectId, final int spellId, final int orb, final int product, final int level, final double xp, final int gfx, final int spellConfig) public int getObjectId(final int object) +public int getAmount(final int object) +public int getSpell() +public int getOrb() +public int getProduct() +public int getLevel() +public double getXP() +public int getOrbGfx() +public int getSpellConfig() ``` diff --git a/docs/Server/classes/OtherObjects.md b/docs/Server/classes/OtherObjects.md index cf4c7e075..10f27d512 100644 --- a/docs/Server/classes/OtherObjects.md +++ b/docs/Server/classes/OtherObjects.md @@ -13,4 +13,18 @@ public static boolean openShantay(Player player, int objectId) public static void movePlayer(Player player) public static void interactCurtain(Player player, int objectType, int x, int y) public static void initKharid(Player player, int objectId) +public static void initShantay(Player player, int objectId) +public static void searchSpecialObject(Player player, int objectType) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void execute(CycleEventContainer container) +public void stop() +public void stop() +public void execute(CycleEventContainer container) +public void execute(CycleEventContainer container) +public void stop() +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Packet.md b/docs/Server/classes/Packet.md index e8b3768df..1d50284ae 100644 --- a/docs/Server/classes/Packet.md +++ b/docs/Server/classes/Packet.md @@ -13,4 +13,48 @@ public boolean isRaw() public int getOpcode() public Type getType() public ByteBuf getPayload() +public int getLength() +public byte get() +public void get(final byte[] b) +public byte getByte() +public int getUnsignedByte() +public short getShort() +public int getUnsignedShort() +public int getUnsignedShortA() +public int getInt() +public long getLong() +public byte getByteC() +public byte getByteS() +public short getLEShortA() +public short getLEShort() +public int getInt1() +public int getInt2() +public int getTriByte() +public byte getByteA() +public String getRS2String() +public short getShortA() +public void getReverse(final byte[] is, final int offset, final int length) +public void getReverseA(final byte[] is, final int offset, final int length) +public void get(final byte[] is, final int offset, final int length) +public int getSmart() +public int getSignedSmart() +public int readUnsignedByte() +public byte readSignedByte() +public byte readSignedByteC() +public int readUnsignedByteS() +public int readHex() +public void readBytes(byte abyte0[], int length, int offset) +public void readBytes_reverseA(byte abyte0[], int length, int offset) +public String readString() +public int readDWord() +public long readQWord() +public long readQWord2() +public int readSignedWordA() +public int readUnsignedWordA() +public int readUnsignedWord() +public int readSignedWord() +public int readSignedWordBigEndian() +public int readSignedWordBigEndianA() +public int readUnsignedWordBigEndian() +public int readUnsignedWordBigEndianA() ``` diff --git a/docs/Server/classes/PacketHandler.md b/docs/Server/classes/PacketHandler.md index 4636b1493..655c96596 100644 --- a/docs/Server/classes/PacketHandler.md +++ b/docs/Server/classes/PacketHandler.md @@ -1,12 +1,12 @@ # PacketHandler -Central dispatcher for all incoming packets. Each opcode is associated with a -`PacketType` implementation in a static array. When the server receives a packet -from a player session, `processPacket` invokes the mapped handler. +Package `com.rs2.net.packets`. -Source: [PacketHandler.java](../../2006Scape%20Server/src/main/java/com/rs2/net/packets/PacketHandler.java) +Defined in [`2006Scape Server/src/main/java/com/rs2/net/packets/PacketHandler.java`](2006Scape Server/src/main/java/com/rs2/net/packets/PacketHandler.java). + +Handles packet related functionality. ```java -// inside a Netty pipeline -PacketHandler.processPacket(player, packet); +public class PacketHandler { +public static void processPacket(Player player, Packet packet) ``` diff --git a/docs/Server/classes/PacketSender.md b/docs/Server/classes/PacketSender.md index a1aaab2b3..029834cd7 100644 --- a/docs/Server/classes/PacketSender.md +++ b/docs/Server/classes/PacketSender.md @@ -13,4 +13,69 @@ public PacketSender sendUpdateItems(int frame, Item[] items) public PacketSender sendUpdateItems(int frame, int[] itemIDs, int[] itemAmounts) public PacketSender loginPlayer() public PacketSender sendClan(String name, String message, String clan, int rights) +public PacketSender createPlayersObjectAnim(int X, int Y, int animationID, int tileObjectType, int orientation) +public PacketSender setInterfaceOffset(int x, int y, int id) +public PacketSender chatbox(int i1) +public PacketSender sendMessage(String s) +public PacketSender frame1() +public PacketSender setInterfaceWalkable(int ID) +public PacketSender sendFrame36(int id, int state) +public PacketSender sendFrame20(int id, int state) +public PacketSender sendString(String s, int id) { // Update string in interfaces etc +public PacketSender sendString(String s, int id, boolean forceSend) { // Update string in interfaces etc +public PacketSender sendFrame107() +public PacketSender sendPlayerDialogueHead(int Frame) +public PacketSender showInterface(int interfaceid) +public PacketSender sendFrame248(int MainFrame, int SubFrame) { //Trade-like interfaces +public PacketSender sendFrame246(int MainFrame, int SubFrame, int SubFrame2) { //A lot of generic interfaces; cooking, etc +public PacketSender sendHideInterfaceLayer(int MainFrame, boolean hidden) { //Special attack bar? +public PacketSender sendDialogueAnimation(int MainFrame, int SubFrame) +public PacketSender sendMapState(int state) { // used for disabling map +public PacketSender sendShowTab(int sideIcon) +public PacketSender sendFrame70(int i, int o, int id) { //Ranging guild minigame +public PacketSender sendNPCDialogueHead(int MainFrame, int SubFrame) +public PacketSender sendChatInterface(int Frame) +public PacketSender setPrivateMessaging(int i) { // friends and ignore list status +public PacketSender setChatOptions(int publicChat, int privateChat, int tradeBlock) +public PacketSender sendFrame87(int id, int state) { //Castlewars and duel arena texts +public PacketSender loadPM(long playerName, int world) +public PacketSender closeAllWindows() +public PacketSender sendFrame34(int id, int slot, int column, int amount) +public PacketSender sendItemOnInterface(int id, int amount, int child) +public PacketSender walkableInterface(int id) +public PacketSender openUpBank() +public PacketSender stillGfx(int id, int x, int y, int height, int time) +public PacketSender setSidebarInterface(int menuId, int form) +public PacketSender flashSideBarIcon(int i1) +public PacketSender createPlayerHints(int type, int id) +public PacketSender createObjectHints(int x, int y, int height, int pos) +public PacketSender object(int objectId, int objectX, int objectY, int face, int objectType) +public PacketSender object(int objectId, int objectX, int objectY, int objectH, int face, int objectType) +public PacketSender tempSong(int songID, int songID2) +public PacketSender frame174(int sound, int vol, int delay) +public PacketSender writeWeight(int weight) +public PacketSender sendConfig(int id, int state) +public PacketSender multiWay(int i1) +public PacketSender sendColor(int id, int color) +public PacketSender sendCrashFrame() +public PacketSender createStillGfx(int id, int x, int y, int height, int time) +public PacketSender object(int objectId, int objectX, int objectY, int objectType) +public PacketSender itemOnInterface(int interfaceChild, int zoom, int itemId) +public PacketSender setConfig(int id, int state) +public PacketSender sendLink(String s) +public PacketSender setSkillLevel(int skillNum, int currentLevel, int XP) +public PacketSender drawHeadicon(int i, int j, int k, int l) +public PacketSender createArrow(int x, int y, int height, int pos) +public PacketSender createArrow(int type, int id) +public PacketSender checkObjectSpawn(int objectId, int objectX, int objectY, int face, int objectType) +public PacketSender createObjectSpawn(int objectId, int objectX, int objectY, int height, int face, int objectType) +public PacketSender showOption(int i, int l, String s, int a) +public PacketSender sendSong(int id) +public PacketSender sendQuickSong(int id, int songDelay) +public PacketSender sendSound(int id, int type, int delay, int volume) +public PacketSender sendSound(int id, int volume, int delay) +public PacketSender sendClearScreen() +public PacketSender createGroundItem(int itemID, int itemX, int itemY, int itemAmount) +public PacketSender createGroundItem(int itemID, int itemX, int itemY, int itemAmount, int height) +public PacketSender removeGroundItem(int itemID, int itemX, int itemY, int Amount) ``` diff --git a/docs/Server/classes/PanelSettings.md b/docs/Server/classes/PanelSettings.md index a80d576f8..ddff9151d 100644 --- a/docs/Server/classes/PanelSettings.md +++ b/docs/Server/classes/PanelSettings.md @@ -13,4 +13,23 @@ public PanelSettings(ControlPanel p) public static String trim(String str) public String getSelectedPlayer() public boolean inList(String id) +public String getColor(String color) +public Client getClient(String name) +public Client getClient(int id) +public boolean validClient(int id) +public boolean validClient(String name) +public boolean validClient(Client c) +public boolean validNpc(int index) +public int getEntity(String name) +public Npc getNpc(int index) +public String getInput(String title, String msg) +public int getInt(String title, String msg) +public void executeCommand(String cmd) +public void playerCommand(String cmd, Client c) +public Location(int x, int y, int z) +public static Location getLocationByName(String name) +public void update(int x, int y, int z) +public int getX() +public int getY() +public int getZ() ``` diff --git a/docs/Server/classes/PartyRoom.md b/docs/Server/classes/PartyRoom.md index d483f6d43..88974a77a 100644 --- a/docs/Server/classes/PartyRoom.md +++ b/docs/Server/classes/PartyRoom.md @@ -13,4 +13,13 @@ public static void startTimer(Player c) public static void dropAll() public static void popBalloon(Player player, int x, int y) public static int arraySlot(int[] array, int itemID) +public static void open(Player player) +public static void accept(Player c) +public static void updateAll() +public static void fix(Player c) +public static void depositItem(Player player, int id, int amount) +public static void withdrawItem(Player c, int slot, int amount) +public static void updateDeposit(Player player) +public static void updateGlobal(Player player) +public static void itemOnInterface(Player player, int frame, int slot, int id, int amount) ``` diff --git a/docs/Server/classes/PathFinder.md b/docs/Server/classes/PathFinder.md index d2d00eb5c..615afb296 100644 --- a/docs/Server/classes/PathFinder.md +++ b/docs/Server/classes/PathFinder.md @@ -8,9 +8,10 @@ Path Finder helper class. ```java public class PathFinder { -private static final PathFinder pathFinder = new PathFinder(); public static PathFinder getPathFinder() public int getRegionCoordinate(int x) public int getLocalCoordinate(int x) public boolean accessible(int x, int y, int heightLevel, int destX, int destY) +public static boolean isProjectilePathClear(int x0, int y0, int z, int x1, int y1) +public int localize(int x, int mapRegion) ``` diff --git a/docs/Server/classes/PestControl.md b/docs/Server/classes/PestControl.md index aea72167c..3c7e5987d 100644 --- a/docs/Server/classes/PestControl.md +++ b/docs/Server/classes/PestControl.md @@ -9,8 +9,20 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/minigames/PestC ```java public class PestControl { public static HashMap waitingBoat = new HashMap(); -private static HashMap gamePlayers = new HashMap(); public int shifter = 3732 + Misc.random(9); public int brawler = 3772 + Misc.random(4); public int defiler = 3762 + Misc.random(9); +public int ravager = 3742 + Misc.random(4); +public int torcher = 3752 + Misc.random(7); +public int splater = 3727 + Misc.random(4); +public void process() +public static void removePlayerGame(Player player) +public static void setGameInterface() +public boolean allPortalsDead3() +public static void leaveWaitingBoat(Player player) +public static void addToWaitRoom(Player player) +public static boolean isInGame(Player player) +public static boolean isInPcBoat(Player player) +public static boolean npcIsPCMonster(int npcType) +public static boolean isPCPortal(int npcType) ``` diff --git a/docs/Server/classes/Pets.md b/docs/Server/classes/Pets.md index 075e8dbde..8904c6b1d 100644 --- a/docs/Server/classes/Pets.md +++ b/docs/Server/classes/Pets.md @@ -13,4 +13,5 @@ public static boolean isCat(int npcId) public static void dropPet(Player player, int itemId, int slot) public void quickPickup(Player player, int id) public void pickUpPet(Player player, int id) +public static int summonItemId(int itemId) ``` diff --git a/docs/Server/classes/Pickable.md b/docs/Server/classes/Pickable.md index ea43526f9..dd6174716 100644 --- a/docs/Server/classes/Pickable.md +++ b/docs/Server/classes/Pickable.md @@ -11,5 +11,4 @@ public class Pickable { public static void pickObject(final Player player, final int objectType, final int objectX, final int objectY) public void execute(CycleEventContainer container) public void stop() -private static int random(int range) ``` diff --git a/docs/Server/classes/Pickpocket.md b/docs/Server/classes/Pickpocket.md index 0485f2caf..55e5fff18 100644 --- a/docs/Server/classes/Pickpocket.md +++ b/docs/Server/classes/Pickpocket.md @@ -13,4 +13,14 @@ public int getLevel() public double getXp() public int[][] getPickPockets() public int getDamage() +public int getStun() +public static int r(int random) +public static boolean isNPC(Player c, int npc) +public static void attemptPickpocket(final Player player, final int npcId) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/PlayList.md b/docs/Server/classes/PlayList.md index 8f04c4c06..f1e80b721 100644 --- a/docs/Server/classes/PlayList.md +++ b/docs/Server/classes/PlayList.md @@ -13,4 +13,9 @@ public int songId() public int configId() public int configNumber() public int arraySlot() +public static Songs get(int id) +public void fixAllColors() +public void playSong(int songID) +public void updateList(int id) +public void handleButton(int button) ``` diff --git a/docs/Server/classes/Player.md b/docs/Server/classes/Player.md index 8cf09edbf..486c6268f 100644 --- a/docs/Server/classes/Player.md +++ b/docs/Server/classes/Player.md @@ -1,20 +1,268 @@ # Player -Represents a logged in user within the game world. The abstract `Player` class holds -core state such as inventories, skills and movement queues. The concrete `Client` -class extends it to handle packet I/O. +Package `com.rs2.game.players`. -Key responsibilities include: +Defined in [`2006Scape Server/src/main/java/com/rs2/game/players/Player.java`](2006Scape Server/src/main/java/com/rs2/game/players/Player.java). -- Managing helper components like `PlayerAssistant`, `CombatAssistant` and - various skill handlers. -- Processing queued packets and updating the world each server tick. -- Handling logout, death and other gameplay related events. - -Source: [Player.java](../../2006Scape%20Server/src/main/java/com/rs2/game/players/Player.java) +Player helper class. ```java -Player p = new Client(session); -p.getPlayerAssistant().movePlayer(3222, 3218, 0); -p.update(); +public abstract class Player { +public ArrayList fishingTrawlerReward = new ArrayList(); +public int getNpcKillCount(int npcId) +public Map getNpcKillCounts() +public void incrementNpcKillCount(int npcId, int count) +public int getXPRate() { return xpRate; } +public void setXPRate(int xpRate) { this.xpRate = xpRate; } +public long getLastHomeTeleport() +public void setLastHomeTeleport(long lastHomeTeleport) +public String getDiscordCode() { return discordCode; } +public void setDiscordCode(String code) { this.discordCode = code; } +public boolean isPreaching() +public void setPreaching(boolean preaching) +public Compost getCompost() +public Allotments getAllotment() +public Flowers getFlowers() +public Herbs getHerbs() +public Hops getHops() +public Bushes getBushes() +public Seedling getSeedling() +public WoodTrees getTrees() +public FruitTree getFruitTrees() +public SpecialPlantOne getSpecialPlantOne() +public SpecialPlantTwo getSpecialPlantTwo() +public ToolLeprechaun getFarmingTools() +public LogCuttingInterface getFletching() +public SingleGates getSingleGates() +public DoubleGates getDoubleGates() +public GateHandler getGateHandler() +public DwarfCannon getCannon() +public ChallengePlayer getChallengePlayer() +public Mining getMining() +public Barrows getBarrows() +public GlassBlowing getGlassBlowing() +public RangersGuild getRangersGuild() +public ObjectManager getObjectManager() +public SmithingInterface getSmithingInt() +public Smithing getSmithing() +public ApeAtollAgility getApeAtollAgility() +public WerewolfAgility getWerewolfAgility() +public PyramidAgility getPyramidAgility() +public BarbarianAgility getBarbarianAgility() +public WildernessAgility getWildernessAgility() +public GnomeAgility getGnomeStrongHold() +public DialogueHandler getDialogueHandler() +public PacketSender getPacketSender() +public SoundList getSound() +public Object getTemporary(String name) +public void addTemporary(String name, Object value) +public PlayList getPlayList() +public Specials getSpecials() +public Potatoes getPTS() +public EmoteHandler getEmoteHandler() +public SkillInterfaces getSkillInterfaces() +public Enchanting getEnchanting() +public PlayerAction getPlayerAction() +public DesertCactus getDesert() +public Agility getAgility() +public Runecrafting getRC() +public Slayer getSlayer() +public Teles getTeles() +public BankPin getBankPin() +public synchronized Stream getOutStream() +public ItemAssistant getItemAssistant() +public PlayerAssistant getPlayerAssistant() +public ShopAssistant getShopAssistant() +public MageTrainingArena getMageTrainingArena() +public Trading getTrading() +public Dueling getDueling() +public CombatAssistant getCombatAssistant() +public PrayerData getPrayer() +public ObjectsActions getObjects() +public NpcActions getNpcs() +public GameSession getSession() +public Potions getPotions() +public PotionMixing getPotMixing() +public Inventory getInventory() +public void setTempInteger(int tempInteger) +public int getTempInteger() +public boolean stopPlayer(boolean stop) +public long getObjectDelay() +public long setObjectDelay(long delay) +public void startCurrentTask(int ticksBetweenExecution, CycleEvent event) +public CycleEventContainer getCurrentTask() +public void endCurrentTask() +public TinterfaceText(String s, int id) +public boolean checkPacket126Update(String text, int id) +public void resetShaking() +public final String disabled() +public void puzzleBarrow() +public void flushOutStream() +public void sendClan(String name, String message, String clan, int rights) +public void destruct() +public void update() +public void logout() +public void logout(boolean forceLogout) +public void post(Player player, E event) +public void post(E event) +public static void provideSubscriber(EventSubscriber subscriber) +public void depriveSubscriber(EventSubscriber subscriber) +public static PluginService getPluginService() +public UniversalEventProvider getSubscribers() +public void antiFirePotion() +public void execute(CycleEventContainer container) +public void stop() +public boolean checkBusy() +public void setBusy(boolean isBusy) +public boolean isBusy() +public int getLastLogin() +public void updateWalkEntities() +public Client getClient(String name) +public Client getClient(int id) +public boolean validClient(int id) +public boolean validClient(String name) +public boolean validClient(Client client) +public void process() +public void queueMessage(Packet arg1) +public void processQueuedPackets() +public void sendSound(int id, int volume, int delay) +public void sendSound(int id, int volume) +public void sendSound(int id) +public void playSound(Client c, int SOUNDID, int delay) +public void correctCoordinates() +public void execute(CycleEventContainer container) +public void stop() +public void trawlerFade(final int x, final int y, final int height) +public void execute(CycleEventContainer container) +public void stop() +public void fade(final int x, final int y, final int height) +public void execute(CycleEventContainer container) +public void stop() +public int getOptionClicked() +public void setOptionClicked(int i) +public String getStatedInterface() +public void setStatedInterface(String statedInterface) +public ArrayList killedPlayers = new ArrayList(); +public ArrayList attackedPlayers = new ArrayList(); +public ArrayList lastKilledPlayers = new ArrayList(); +public void setSpecialTarget(Npc target) +public Npc getSpecialTarget() +public Pets getSummon() +public boolean isRunning() +public void faceNpc(int npc) +public void faceNPC(int index) +public void appendFaceNPCUpdate(Stream str) +public int getLocalX() +public int getLocalY() +public int getKillCount() +public void setRandomGrave(int randomGrave) +public int getRandomGrave() +public void setBarrowsNpcDead(int index, boolean dead) +public boolean[] getBarrowsNpcDead() +public boolean getBarrowsNpcDead(int id) +public Npc getCloseRandomNpc(int distance) +public boolean isAutoButton(int button) +public void assignAutocast(int button) +public boolean inCwGame() +public void gameInterface(int id) +public boolean hasThievedStall() +public void setHasThievedStall(boolean hasThievedStall) +public boolean hasSearchedForTraps() +public void setHasSearchedForTraps(boolean hasSearchedForTraps) +public Client asClient() +public Player asPlayer() +public boolean inTrawlerBoat() +public boolean inTrawlerGame() +public boolean inCw() +public boolean inBarrows() +public boolean inArea(int x, int y, int x1, int y1) +public boolean inKqArea() +public boolean inWild() +public boolean inPlayerShopArea() +public boolean duelingArena() +public boolean playerIsBusy() +public boolean inDuelArena() +public boolean isInArea(final int x1, final int y1, final int x2, final int y2) +public boolean isInAreaxxyy(final int x1, final int x2, final int y1, final int y2) +public boolean altars() +public boolean safeAreas(int x, int y, int x1, int y1) +public boolean inFightCaves() +public boolean inPirateHouse() +public void updateShop(int i) +public void println_debug(String str) +public void println(String str) +public Player(int _playerId) +public boolean withinDistance(Player otherPlr) +public boolean withinDistance(Npc npc) +public boolean withinDistance(int absX, int getY, int getHeightLevel) +public int distanceToPoint(int pointX, int pointY) +public void resetWalkingQueue() +public void addToWalkingQueue(int x, int y) +public boolean checkRangeDistance() +public int gatherRangeDistance(int distance) +public boolean goodDistance(int objectX, int objectY, int playerX, int playerY, int distance) +public boolean goodObjectDistance(int objectX, int objectY, int playerX, int playerY, int distance) +public int getNextWalkingDirection() +public synchronized void getNextPlayerMovement() +public void updateThisPlayerMovement(Stream str) +public void updatePlayerMovement(Stream str) +public void addNewNPC(Npc npc, Stream str, Stream updateBlock) +public void addNewPlayer(Player plr, Stream str, Stream updateBlock) +public int calculateCombatLevel() +public void forcedChat(String text) +public void appendForcedChat(Stream str) +public void appendMask100Update(Stream str) +public void gfx100(int gfx) +public void gfx0(int gfx) +public boolean wearing2h() +public void startAnimation(int animId) +public void startAnimation(int animId, int time) +public void appendAnimationRequest(Stream str) +public void faceUpdate(int index) +public void appendFaceUpdate(Stream str) +public void turnPlayerTo(int pointX, int pointY) +public void appendPlayerUpdateBlock(Stream str) +public void clearUpdateFlags() +public void stopMovement() +public void preProcessing() +public void postProcessing() +public int getMapRegionX() +public int getMapRegionY() +public int getX() +public int getY() +public int getH() +public int getId() +public void setHitDiff(int hitDiff) +public void setHitDiff2(int hitDiff2) +public int getHitDiff() +public void setHitUpdateRequired(boolean hitUpdateRequired) +public void setHitUpdateRequired2(boolean hitUpdateRequired2) +public boolean isHitUpdateRequired() +public boolean getHitUpdateRequired() +public boolean getHitUpdateRequired2() +public void setAppearanceUpdateRequired(boolean appearanceUpdateRequired) +public boolean isAppearanceUpdateRequired() +public void setChatTextEffects(int chatTextEffects) +public int getChatTextEffects() +public void setChatTextSize(byte chatTextSize) +public byte getChatTextSize() +public void setChatTextUpdateRequired(boolean chatTextUpdateRequired) +public boolean isChatTextUpdateRequired() +public void setChatText(byte chatText[]) +public byte[] getChatText() +public void setChatTextColor(int chatTextColor) +public int getChatTextColor() +public void setNewWalkCmdX(int newWalkCmdX[]) +public int[] getNewWalkCmdX() +public void setNewWalkCmdY(int newWalkCmdY[]) +public int[] getNewWalkCmdY() +public void setNewWalkCmdIsRunning(boolean newWalkCmdIsRunning) +public boolean isNewWalkCmdIsRunning() +public void setInStreamDecryption(IsaacRandom inStreamDecryption) +public void setOutStreamDecryption(IsaacRandom outStreamDecryption) +public boolean samePlayer() +public void putInCombat(int attacker) +public void dealDamage(int damage) +public void appendRedemption() +public void handleHitMask(int damage) ``` diff --git a/docs/Server/classes/PlayerAction.md b/docs/Server/classes/PlayerAction.md index a574e139c..0bc67810f 100644 --- a/docs/Server/classes/PlayerAction.md +++ b/docs/Server/classes/PlayerAction.md @@ -13,4 +13,6 @@ public boolean setAction(boolean action) public boolean checkAction() public boolean canWalk(boolean walk) public boolean checkWalking() +public boolean canEat(boolean eat) +public boolean checkEating() ``` diff --git a/docs/Server/classes/PlayerAssistant.md b/docs/Server/classes/PlayerAssistant.md index 0608d4035..30508af59 100644 --- a/docs/Server/classes/PlayerAssistant.md +++ b/docs/Server/classes/PlayerAssistant.md @@ -13,4 +13,108 @@ public boolean savePlayer() public void handleROL() public void objectAnim(int X, int Y, int animationID, int tileObjectType, int orientation) public void resetAutocast() +public void setAnimationBack() +public boolean isPlayer() +public void handleObjectRegion(int objectId, int minX, int minY, int maxX, int maxY) +public boolean itemUsedInRegion(int minX, int maxX, int minY, int maxY) +public void loginScreen() +public void showMap() +public ArrayList randomFish(int fish) +public void removeFishingTrawlerRewardItem(int slot, boolean all) +public void removeAllSidebars() +public void resetAnimationsToPrevious() +public void otherInv(Client c, Client o) +public void otherBank(Client c, Client o) +public void startFading(final int occurrence, final int x, final int y, final int h) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container2) +public void stop() +public void sendSidebars() +public boolean removeGloves() +public void feature(String feature) +public static void removeHintIcon(Player c) +public void hideAllSideBars() +public void writeEnergy() +public int raiseTimer() +public void handleTiara() +public static boolean pathBlocked(Client attacker, Client victim) +public static boolean pathBlocked(Client attacker, Npc victim) +public void stepAway() +public void squeezeThroughRailing() +public void spiritTree() +public void handleCanoe() +public boolean bananasCheck() +public void spellTeleport(int x, int y, int height) +public void startTeleport(int x, int y, int height, String teleportType) +public void startTeleport2(int x, int y, int height) +public void gloryTeleport(int x, int y, int height, String teleportType) +public void processTeleport() +public void movePlayer(int x, int y, int h) +public void playerWalk(int x, int y) +public void handleEmpty() +public void resetTzhaar() +public void enterCaves() +public void execute(CycleEventContainer container) +public void stop() +public void addStarter() +public void hitPlayers(int x1, int x2, int y1, int y2, int hp) +public void createPlayersStillGfx(int id, int x, int y, int height, int time) +public void logIntoPM() +public void updatePM(int pID, int world) { // used for private chat updates +public boolean isInPM(long l) +public void magicOnItems(int slot, int itemId, int spellId) +public String deathMsgs() +public void resetDamageDone() +public void resetTb() +public void resetFollowers() +public void applyDead() +public void giveLife() +public void changeLocation() +public int[] getFollowLocation(int x, int y) +public void followPlayer() +public void followNpc() +public int getRunningMove(int i, int j) +public void resetFollow() +public void walkTo(int i, int j) +public void walkTo2(int i, int j) +public void stopDiagonal(int otherX, int otherY) +public void walkToCheck(int i, int j) +public int getMove(int place1, int place2) +public boolean fullVeracs() +public boolean fullGuthans() +public void resetAnimation() +public void requestUpdates() +public void sendAutoRetalitate() +public void firstTimeTutorial() +public int getTotalLevel() +public void levelUp(int skill) +public void refreshSkill(int skill) +public static int getXPForLevel(int level) +public static int getLevelForXP(int exp) +public boolean addSkillXP(double amount, int skill) +public void resetBarrows() +public int getNpcId(int id) +public void removeObject(int x, int y) +public void removeObjects() +public boolean inPitsWait() +public int antiFire() +public boolean checkForFlags() +public int getWearingAmount() +public void getSpeared(int otherX, int otherY) +public void moveCheck(int xMove, int yMove) +public int findKiller() +public void appendPoison(int damage) +public boolean checkForPlayer(int x, int y) +public void checkPouch(int i) +public void fillPouch(int i) +public void emptyPouch(int i) +public void fixAllBarrows() +public void handleWeaponStyle() +public int totalGold() +public void unMorphPlayer() +public void sendCameraCutscene(int x, int y, int height, int speed, int angle) +public void sendCameraCutscene2(int x, int y, int height, int speed, int angle) +public void sendCameraShake(int i1, int i2, int i3, int i4) +public void sendCameraReset() ``` diff --git a/docs/Server/classes/PlayerCredentials.md b/docs/Server/classes/PlayerCredentials.md index f2ebde3eb..44f8f37cc 100644 --- a/docs/Server/classes/PlayerCredentials.md +++ b/docs/Server/classes/PlayerCredentials.md @@ -13,4 +13,9 @@ public long getEncodedUsername() public void setPassword(String password) public String getPassword() public int getUid() +public String getUsername() +public int getUsernameHash() +public String getHostAddress() +public int hashCode() +public boolean equals(Object obj) ``` diff --git a/docs/Server/classes/PlayerHandler.md b/docs/Server/classes/PlayerHandler.md index bcf1fa96e..73ad4022a 100644 --- a/docs/Server/classes/PlayerHandler.md +++ b/docs/Server/classes/PlayerHandler.md @@ -1,12 +1,21 @@ # PlayerHandler -Maintains the global player list, assigning slots to new connections and -processing each active player every tick. `PlayerHandler` updates player -counters and saves data on logout. +Package `com.rs2.game.players`. -Source: [PlayerHandler.java](../../2006Scape%20Server/src/main/java/com/rs2/game/players/PlayerHandler.java) +Defined in [`2006Scape Server/src/main/java/com/rs2/game/players/PlayerHandler.java`](2006Scape Server/src/main/java/com/rs2/game/players/PlayerHandler.java). + +Handles player related functionality. ```java -// called from GameEngine each server tick -playerHandler.process(); +public class PlayerHandler { +public boolean newPlayerClient(Client client1) +public static int getPlayerCount() +public static int getNonPlayerCount() +public static int getPlayerShopCount() +public void updatePlayerNames() +public static int getPlayerID(String playerName) +public static boolean isPlayerOn(String playerName) +public void process() +public void updateNPC(Player plr, Stream str) +public void updatePlayer(Player plr, Stream outStr) ``` diff --git a/docs/Server/classes/PlayersOnlineWebsite.md b/docs/Server/classes/PlayersOnlineWebsite.md index 6374be777..776bf73a4 100644 --- a/docs/Server/classes/PlayersOnlineWebsite.md +++ b/docs/Server/classes/PlayersOnlineWebsite.md @@ -8,6 +8,5 @@ Players Online Website helper class. ```java public class PlayersOnlineWebsite { -private static void setWebsitePlayersOnline(int amount) throws IOException public static void addUpdatePlayersOnlineTask() ``` diff --git a/docs/Server/classes/PluginService.md b/docs/Server/classes/PluginService.md index 8dec723a8..432250494 100644 --- a/docs/Server/classes/PluginService.md +++ b/docs/Server/classes/PluginService.md @@ -8,9 +8,7 @@ The service that services plugins. @author Vult-R ```java public final class PluginService { -private static final Logger logger = LoggerUtils.getLogger(PluginService.class); -private static final List> subscribers = new ArrayList<>(); public void load() -private Collection> findPlugins() throws IOException -private Collection> findPlugins(File dir) +public void reload() +public List> getSubscribers() ``` diff --git a/docs/Server/classes/Position.md b/docs/Server/classes/Position.md index 0b68b2e61..48516990e 100644 --- a/docs/Server/classes/Position.md +++ b/docs/Server/classes/Position.md @@ -13,4 +13,6 @@ public static boolean checkPlayerX(Player client, int x, int h) public static boolean checkPlayerY(Player player, int y, int h) public static boolean checkPlayerH(Player client, int h) public static boolean checkObject(Player client, int x, int y, int h) +public static boolean checkObjectX(Player client, int x, int h) +public static boolean checkObjectY(Player client, int y, int h) ``` diff --git a/docs/Server/classes/Potatoes.md b/docs/Server/classes/Potatoes.md index abe9eb059..67f4ce6ee 100644 --- a/docs/Server/classes/Potatoes.md +++ b/docs/Server/classes/Potatoes.md @@ -13,4 +13,7 @@ public int getNewPotatoID() public int getIngredient() public int getReq() public int getXP() +public static PotatoMaking forId(int id) +public void handlePotato(int id1, int id2) +public boolean makePotato(int id) ``` diff --git a/docs/Server/classes/Potions.md b/docs/Server/classes/Potions.md index b2f555ee3..39820e762 100644 --- a/docs/Server/classes/Potions.md +++ b/docs/Server/classes/Potions.md @@ -12,5 +12,14 @@ public Potions(Player player) public void handlePotion(int itemId, int slot) public void execute(CycleEventContainer container) public void stop() -private void energyPotion(int itemId, int replaceItem, int slot) +public void curePoison(long delay) +public void restoreStats() +public void doTheBrewzam(int itemId, int replaceItem, int slot) +public void doTheBrew(int itemId, int replaceItem, int slot) +public void enchanceStat(int skillID, boolean sup) +public void antifirePot(int itemId, int replaceItem, int slot) +public int getBrewStat(int skill, double amount) +public int getBoostedStat(int skill, boolean sup) +public boolean isPotion(int itemId) +public boolean potionNames(int itemId) ``` diff --git a/docs/Server/classes/Pottery.md b/docs/Server/classes/Pottery.md index a8d0f3699..52997c80b 100644 --- a/docs/Server/classes/Pottery.md +++ b/docs/Server/classes/Pottery.md @@ -13,4 +13,5 @@ public static void showFire(Player c) public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Prayer.md b/docs/Server/classes/Prayer.md index 752907b2e..bfa13a51e 100644 --- a/docs/Server/classes/Prayer.md +++ b/docs/Server/classes/Prayer.md @@ -9,7 +9,6 @@ Class Prayer Handles Prayer @author 2012 23:56 29/12/2010 ```java public class Prayer { public static boolean playerBones(Player player, int item) -private static void handleBones(final Player c, int i, int slot) public void execute(CycleEventContainer container) public void stop() public static void buryBones(Player c, int i, int slot) diff --git a/docs/Server/classes/PyramidAgility.md b/docs/Server/classes/PyramidAgility.md index 5f1fd9098..8e6d98e82 100644 --- a/docs/Server/classes/PyramidAgility.md +++ b/docs/Server/classes/PyramidAgility.md @@ -13,4 +13,21 @@ public boolean pyramidCourse(int objectId) public void execute(CycleEventContainer container) public void stop() public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/QuestAssistant.md b/docs/Server/classes/QuestAssistant.md index 0d92b99c8..2fd71fe84 100644 --- a/docs/Server/classes/QuestAssistant.md +++ b/docs/Server/classes/QuestAssistant.md @@ -9,8 +9,10 @@ Quest Assistant @author Andrew (Mr Extremez) ```java public class QuestAssistant { public static void sendStages(Player player) -private Quests(final int button, final int string, final String name, final boolean questStatus) public int getStringId() public boolean questStatus() public int getButton() +public String getName() +public static Quests forButton(int button) +public static void questButtons(Player player, int buttonId) ``` diff --git a/docs/Server/classes/QuestRewards.md b/docs/Server/classes/QuestRewards.md index fafbd599b..6dcdb4488 100644 --- a/docs/Server/classes/QuestRewards.md +++ b/docs/Server/classes/QuestRewards.md @@ -13,4 +13,15 @@ public static void knightsReward(Player player) public static void gertFinish(Player player) public static void pirateFinish(Player c) public static void witchFinish(Player client) +public static void julietFinish(Player player) +public static void restFinish(Player client) +public static void vampFinish(Player player) +public static void runeFinish(Player player) +public static void sheepFinish(Player player) +public static void doricFinish(Player player) +public static void impFinish(Player player) +public static void cookReward(Player player) +public static void blackKnightReward(Player player) +public static void shieldArravReward(Player player) +public static void lostCityReward(Player player) ``` diff --git a/docs/Server/classes/RS2ProtocolDecoder.md b/docs/Server/classes/RS2ProtocolDecoder.md index 037e8188d..871b5cfa8 100644 --- a/docs/Server/classes/RS2ProtocolDecoder.md +++ b/docs/Server/classes/RS2ProtocolDecoder.md @@ -9,8 +9,4 @@ RS2Protocol Decoder helper class. ```java public class RS2ProtocolDecoder extends StatefulFrameDecoder { public RS2ProtocolDecoder(IsaacRandom isaac) -protected void decode(ChannelHandlerContext ctx, ByteBuf in, List out, GameDecoderState state) -private void decodeLength(ByteBuf buffer) -private void decodeOpcode(ByteBuf buffer, List out) -private void decodePayload(ByteBuf buffer, List out) ``` diff --git a/docs/Server/classes/RangeData.md b/docs/Server/classes/RangeData.md index 35f692eab..8914ac793 100644 --- a/docs/Server/classes/RangeData.md +++ b/docs/Server/classes/RangeData.md @@ -13,4 +13,11 @@ public static boolean usingBolts(Player c) public static boolean properBolts(Player c) public static boolean usingHally(Player c) public static boolean usingDart(Player player) +public static boolean usingLongbow(Player player) +public static int correctBowAndArrows(Player c) +public static int getRangeStartGFX(Player c) +public static int getRangeProjectileGFX(Player c) +public static int getProjectileSpeed(Player c) +public static int getProjectileShowDelay(Player c) +public static boolean fullVoidRange(Player c) ``` diff --git a/docs/Server/classes/RangersGuild.md b/docs/Server/classes/RangersGuild.md index 7bb1da847..73269b42b 100644 --- a/docs/Server/classes/RangersGuild.md +++ b/docs/Server/classes/RangersGuild.md @@ -12,5 +12,8 @@ public RangersGuild(Player player) public void fireAtTarget() public void execute(CycleEventContainer container) public void stop() -private void sendConfiguration(int xPos, int yPos) +public boolean isInTargetArea() +public void exchangePoints() +public void howAmIDoing() +public void buyArrows() ``` diff --git a/docs/Server/classes/Region.md b/docs/Server/classes/Region.md index fa04ba830..2737fcc3d 100644 --- a/docs/Server/classes/Region.md +++ b/docs/Server/classes/Region.md @@ -8,9 +8,28 @@ Region helper class. ```java public class Region { -private ArrayList realObjects = new ArrayList(); public Region(int id, boolean members) public int id() public boolean members() public static boolean isMembers(int x, int y) +public static Region getRegion(int x, int y) +public static int getRegionId(int x, int y) +public static Objects getObject(int id, int x, int y, int z) +public static boolean objectExists(int id, int x, int y, int z) +public void removeClipping(int x, int y, int height) +public static boolean canMove(int x, int y, int z, int direction) +public static boolean canShoot(int x, int y, int z, int direction) +public static boolean projectileBlockedNorth(int x, int y, int z) +public static boolean projectileBlockedEast(int x, int y, int z) +public static boolean projectileBlockedSouth(int x, int y, int z) +public static boolean projectileBlockedWest(int x, int y, int z) +public static boolean projectileBlockedNorthEast(int x, int y, int z) +public static boolean projectileBlockedNorthWest(int x, int y, int z) +public static boolean projectileBlockedSouthEast(int x, int y, int z) +public static boolean projectileBlockedSouthWest(int x, int y, int z) +public static boolean canMove(int startX, int startY, int endX, int endY, int height, int xLength, int yLength) +public static void addClipping(int x, int y, int height, int shift) +public static void addObject(int objectId, int x, int y, int height, int type, int direction, boolean startUp) +public static int getClipping(int x, int y, int height) +public static int getProjectileClipping(int x, int y, int height) ``` diff --git a/docs/Server/classes/RegionFactory.md b/docs/Server/classes/RegionFactory.md index 86271417a..fd54f509f 100644 --- a/docs/Server/classes/RegionFactory.md +++ b/docs/Server/classes/RegionFactory.md @@ -10,5 +10,4 @@ Region Factory helper class. public class RegionFactory { public static Region[] getRegions() public static void load(IndexedFileSystem fs) throws IOException -private static void loadMaps(int regionId, ByteStream str1, ByteStream str2) ``` diff --git a/docs/Server/classes/RegisteredAccsWebsite.md b/docs/Server/classes/RegisteredAccsWebsite.md index 4028688e9..d8a064bf8 100644 --- a/docs/Server/classes/RegisteredAccsWebsite.md +++ b/docs/Server/classes/RegisteredAccsWebsite.md @@ -8,6 +8,5 @@ Registered Accs Website helper class. ```java public class RegisteredAccsWebsite { -private static void setAccountsRegistered(int amount) throws IOException public static void addUpdateRegisteredUsersTask() ``` diff --git a/docs/Server/classes/RequestWorker.md b/docs/Server/classes/RequestWorker.md index 8c973ff5b..12f8bc701 100644 --- a/docs/Server/classes/RequestWorker.md +++ b/docs/Server/classes/RequestWorker.md @@ -9,8 +9,6 @@ The base class for request workers. @author Graham @param The type of reque ```java * The base class for request workers. public RequestWorker(UpdateDispatcher dispatcher, P provider) -protected abstract ChannelRequest nextRequest(UpdateDispatcher dispatcher) throws InterruptedException; public final void run() -protected abstract void service(P provider, Channel channel, T request) throws IOException; public final void stop() ``` diff --git a/docs/Server/classes/RequestWorkerPool.md b/docs/Server/classes/RequestWorkerPool.md index 989bbecbf..da68b6d11 100644 --- a/docs/Server/classes/RequestWorkerPool.md +++ b/docs/Server/classes/RequestWorkerPool.md @@ -8,9 +8,8 @@ A class which manages the pool of request workers. @author Graham @author Ryley ```java * A class which manages the pool of request workers. -private static final int THREADS_PER_REQUEST_TYPE = Runtime.getRuntime().availableProcessors(); -private final List> workers = new ArrayList>(); public static UpdateDispatcher getDispatcher() public RequestWorkerPool() -private static final UpdateDispatcher dispatcher = new UpdateDispatcher(); +public void start() throws Exception +public void stop() ``` diff --git a/docs/Server/classes/Runecrafting.md b/docs/Server/classes/Runecrafting.md index 69dfdb9d4..93f461f85 100644 --- a/docs/Server/classes/Runecrafting.md +++ b/docs/Server/classes/Runecrafting.md @@ -10,7 +10,10 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/runecraf public class Runecrafting { public Runecrafting(Player player) public static void locate(Player c, int xPos, int yPos) -private Altars(int objId, int[] keys, int[] loc) -private int getObj() -private int[] getKeys() +public void enterAltar(int objId, int itemUse) +public Altar_Data forObj(int obj) +public Altars forAltar(int id) +public boolean craftRunes(int obj) +public void getMultiSupport(int obj) +public int getMultiplier(Altar_Data ad) ``` diff --git a/docs/Server/classes/Sailing.md b/docs/Server/classes/Sailing.md index bc6d68313..04feb1304 100644 --- a/docs/Server/classes/Sailing.md +++ b/docs/Server/classes/Sailing.md @@ -13,4 +13,11 @@ public static boolean checkForCoins(Player c) public static boolean searchForAlcohol(Player c) public static boolean quickSearch(Player c) public static void startTravel(final Player c, final int i) +public void execute(CycleEventContainer container) +public void stop() +public void execute(CycleEventContainer container) +public void stop() +public static int getX(int i) +public static int getY(int i) +public static int getTime(int i) ``` diff --git a/docs/Server/classes/SearchForTraps.md b/docs/Server/classes/SearchForTraps.md index c66f3f3b9..6be9fbce6 100644 --- a/docs/Server/classes/SearchForTraps.md +++ b/docs/Server/classes/SearchForTraps.md @@ -8,9 +8,11 @@ Search For Traps helper class. ```java public class SearchForTraps { -private chestsWithTraps(final int chestId, final int levelReq, final double xp, int[][] reward, boolean randomizeRewards) public int getChestId() public int getLevelReq() public double getXp() public int[][] getReward() +public static void searchForTraps(final Player client, final int chestId) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Searching.md b/docs/Server/classes/Searching.md index d14d35ba1..3ae121817 100644 --- a/docs/Server/classes/Searching.md +++ b/docs/Server/classes/Searching.md @@ -8,8 +8,5 @@ Searching helper class. ```java public class Searching { -private SearchData(int[] objectId, String searchText) -private int[] getObjectId() -private String getObjectText() public static void searchObject(final Player player, int objectType) ``` diff --git a/docs/Server/classes/Seedling.md b/docs/Server/classes/Seedling.md index 17f89c1cb..2ded70ec5 100644 --- a/docs/Server/classes/Seedling.md +++ b/docs/Server/classes/Seedling.md @@ -9,8 +9,14 @@ Created by IntelliJ IDEA. User: vayken Date: 18/03/12 Time: 11:00 To change this ```java public class Seedling { public Seedling(Player player) -private static Map seeds = new HashMap(); -private static Map unwatered = new HashMap(); -private static Map watered = new HashMap(); public static SeedlingData getSeed(int seedId) +public static SeedlingData getUnwatered(int seedId) +public static SeedlingData getWatered(int seedId) +public int getSeedId() +public int getUnwateredSeedlingId() +public int getWateredSeedlingId() +public int getSaplingId() +public void makeSaplingInInv(int itemId) +public void makeSaplingInBank(int itemId) +public boolean fillPotWithSoil(int itemId, int objectX, int objectY) ``` diff --git a/docs/Server/classes/ServiceChannelInitializer.md b/docs/Server/classes/ServiceChannelInitializer.md index 188f12c5b..c0fa5a7aa 100644 --- a/docs/Server/classes/ServiceChannelInitializer.md +++ b/docs/Server/classes/ServiceChannelInitializer.md @@ -9,5 +9,4 @@ A {@link ChannelInitializer} for the service pipeline. @author Graham ```java public final class ServiceChannelInitializer extends ChannelInitializer { public ServiceChannelInitializer(ChannelInboundHandlerAdapter handler) -protected void initChannel(SocketChannel ch) throws Exception ``` diff --git a/docs/Server/classes/Session.md b/docs/Server/classes/Session.md index 9d5f67c57..cb1a2c7fc 100644 --- a/docs/Server/classes/Session.md +++ b/docs/Server/classes/Session.md @@ -11,5 +11,4 @@ public abstract class Session { public Session(Channel channel) public abstract void destroy(); public abstract void messageReceived(Object message) throws Exception; -protected final Channel getChannel() ``` diff --git a/docs/Server/classes/ShopAssistant.md b/docs/Server/classes/ShopAssistant.md index 523b27bde..9230bd4f2 100644 --- a/docs/Server/classes/ShopAssistant.md +++ b/docs/Server/classes/ShopAssistant.md @@ -13,4 +13,15 @@ public void openShop(int ShopID) public void updatePlayerShop() public void updateshop(int i) public void resetShop(int ShopID) +public int getItemShopValue(int ItemID, int Type, boolean isSelling) +public int getItemShopValue(int itemId) +public void buyFromShopPrice(int itemID) +public int getCastleItemValue(int id) +public int getPestItemValue(int id) +public int getRGItemValue(int id) +public int getTokkulValue(int id) +public void sellToShopPrice(int removeId, int removeSlot) +public boolean sellItem(int itemID, int fromSlot, int amount) +public boolean addShopItem(int itemID, int amount) +public boolean buyItem(int itemID, int fromSlot, int amount) ``` diff --git a/docs/Server/classes/ShopData.md b/docs/Server/classes/ShopData.md index 1bdb934d0..c31276dee 100644 --- a/docs/Server/classes/ShopData.md +++ b/docs/Server/classes/ShopData.md @@ -13,4 +13,7 @@ public int getId() public String getName() public int getSellModifier() public int getBuyModifier() +public ShopItems[] getItems() +public int getItemId() +public int getItemAmount() ``` diff --git a/docs/Server/classes/ShopHandler.md b/docs/Server/classes/ShopHandler.md index 493299b40..f75bde9de 100644 --- a/docs/Server/classes/ShopHandler.md +++ b/docs/Server/classes/ShopHandler.md @@ -11,6 +11,12 @@ public class ShopHandler { public ShopHandler() public static int restockTimeItem(int itemId) public void process() -private void DiscountItem(int shopID, int ArrayID) -private static void ResetItem(int shopID, int ArrayID) +public void loadShops() +public boolean writeShops(String FileName) +public static void createPlayerShop(Client player) +public static void closePlayerShop(Client player) +public static void refreshshop(int shop_id) +public static int getStock(int shop_id, int item_id) +public static void buyItem(int shop_id, int item_id, int amount) +public static boolean playerOwnsStore(int shop_id, Player player) ``` diff --git a/docs/Server/classes/Shops.md b/docs/Server/classes/Shops.md index c7a649c6a..acf069d4b 100644 --- a/docs/Server/classes/Shops.md +++ b/docs/Server/classes/Shops.md @@ -10,7 +10,8 @@ Shops @author Andrew (I'm A Boss on Rune-Server, Mr Extremez on Moparscape & Run public class Shops { public static HashMap npc = new HashMap(); public static Shop forId(int id) -private Shop(int npcId, int shopId) public int getNpc() public int getShop() +public static void dialogueShop(Player c, int npcClick) +public static void openShop(Player c, int npcClickId) ``` diff --git a/docs/Server/classes/SilverCrafting.md b/docs/Server/classes/SilverCrafting.md index 9f11de772..395564b6f 100644 --- a/docs/Server/classes/SilverCrafting.md +++ b/docs/Server/classes/SilverCrafting.md @@ -13,4 +13,9 @@ public static SilverCraft forId(int id) public int getButtonId() public int getUsed() public int getResult() +public int getAmount() +public int getLevel() +public double getExperience() +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/SkillConstants.md b/docs/Server/classes/SkillConstants.md index e5c38e970..f0a46f827 100644 --- a/docs/Server/classes/SkillConstants.md +++ b/docs/Server/classes/SkillConstants.md @@ -8,7 +8,6 @@ SkillConstants.java @author Andrew (Mr Extremez) ```java public enum SkillConstants { -private SkillConstants(boolean skillEnabled) public static boolean getEnabled(int id) public static String getName(SkillConstants skillConstants) ``` diff --git a/docs/Server/classes/SkillData.md b/docs/Server/classes/SkillData.md index 84f15df6f..f28eb361b 100644 --- a/docs/Server/classes/SkillData.md +++ b/docs/Server/classes/SkillData.md @@ -13,4 +13,9 @@ public final int getFrame1() public final int getFrame2() public final int getFrame3() public final int getFrame4() +public final int getFrame5() +public final int getFrame6() +public final int getFrame7() +public String toString() +public static Optional getSkill(int identifier) ``` diff --git a/docs/Server/classes/SkillHandler.md b/docs/Server/classes/SkillHandler.md index c09c8c030..55330c20d 100644 --- a/docs/Server/classes/SkillHandler.md +++ b/docs/Server/classes/SkillHandler.md @@ -13,4 +13,10 @@ public static void resetItemOnNpc(Player player) public static void resetSkills(Player player) {// call when walking, dropping, public static boolean canDoAction(int timer) public static boolean noInventorySpace(Player c, String skill) +public static void deleteTime(Player c) +public static void stopEvents(Player player, int eventId) +public static void send1Item(Player c, int itemId) +public static void resetPlayerSkillVariables(Player c) +public static boolean skillCheck(int level, int levelRequired, int itemBonus) +public static String getLine(Player c) ``` diff --git a/docs/Server/classes/SkillInterfaces.md b/docs/Server/classes/SkillInterfaces.md index e3217706b..e77ecb030 100644 --- a/docs/Server/classes/SkillInterfaces.md +++ b/docs/Server/classes/SkillInterfaces.md @@ -10,7 +10,25 @@ Skill Interfaces helper class. public class SkillInterfaces { public SkillInterfaces(Player player) public void menuCompilation(int screen) -private void clearMenu() -private void writeInterfaceItem(int id[]) public void attackComplex(int screen) +public void strengthComplex(int screen) +public void defenceComplex(int screen) +public void rangedComplex(int screen) +public void prayerComplex(int screen) +public void magicComplex(int screen) +public void runecraftingComplex(int screen) +public void hitpointsComplex(int screen) +public void agilityComplex(int screen) +public void herbloreComplex(int screen) +public void thievingComplex(int screen) +public void craftingComplex(int screen) +public void fletchingComplex(int screen) +public void slayerComplex(int screen) +public void miningComplex(int screen) +public void smithingComplex(int screen) +public void fishingComplex(int screen) +public void cookingComplex(int screen) +public void firemakingComplex(int screen) +public void woodcuttingComplex(int screen) +public void farmingComplex(int screen) ``` diff --git a/docs/Server/classes/SkillMenu.md b/docs/Server/classes/SkillMenu.md index fbb5c0570..b0a50642a 100644 --- a/docs/Server/classes/SkillMenu.md +++ b/docs/Server/classes/SkillMenu.md @@ -9,7 +9,4 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/SkillMen ```java public class SkillMenu { public static void openInterface(Client c, int skillType) -private static void removeSidebars(Client c) -private static void writeItems(Client c, int skillType) -private static void writeText(Client c, int skillType) ``` diff --git a/docs/Server/classes/Slayer.md b/docs/Server/classes/Slayer.md index f83c1e17e..cd524d6c1 100644 --- a/docs/Server/classes/Slayer.md +++ b/docs/Server/classes/Slayer.md @@ -13,4 +13,42 @@ public static ArrayList easyTask = new ArrayList(); public static ArrayList mediumTask = new ArrayList(); public static ArrayList hardTask = new ArrayList(); public static ArrayList veryHardTask = new ArrayList(); +public Slayer(Player player) +public int getId() +public int getCombatRequirement() +public String getLocation() +public String getMaster() +public int getDifficulty() +public int getNpcId() +public int getExp() +public int getLevelReq() +public int getDifficulty() +public String getLocation() +public static int r(int random) +public boolean canAttackNpc(int i) +public void resizeTable(int difficulty) +public static boolean getMasterRequirment(Player player, int id) +public int getTaskExp(int npcId) +public int getRequiredLevel(int npcId) +public String getLocation(int npcId) +public String getMasterLocation(int npcId) +public boolean isSlayerNpc(int npcId) +public boolean isSlayerTask(int npcId) +public int getDifficulty(int npcId) +public String getSlayerMaster(int npcId) +public String getTaskName(int npcId) +public int getTaskId(String name) +public boolean hasTask() +public void generateTask() +public int getTaskAmount(int task_id) +public int getSlayerDifficulty(Player c2) +public int getRandomTask(int diff) +public void cancelTask() +public void removeTask() +public void updatePoints() +public void updateCurrentlyRemoved() +public void buySlayerExperience() +public void buySlayerDart() +public void buyBroadArrows() +public void buyRespite() ``` diff --git a/docs/Server/classes/Smelting.md b/docs/Server/classes/Smelting.md index f2875bce8..132be99d8 100644 --- a/docs/Server/classes/Smelting.md +++ b/docs/Server/classes/Smelting.md @@ -13,4 +13,8 @@ public static void doAmount(Player c, int amount, int bartype) public static void smeltBar(final Player c, int bartype) public void execute(CycleEventContainer container) public void stop() +public void execute(CycleEventContainer container) +public void stop() +public static void getBar(Player c, int i) +public static void resetSmelting(Player player) ``` diff --git a/docs/Server/classes/Smithing.md b/docs/Server/classes/Smithing.md index dfe17ef7d..39f237919 100644 --- a/docs/Server/classes/Smithing.md +++ b/docs/Server/classes/Smithing.md @@ -8,9 +8,8 @@ Smithing helper class. ```java public class Smithing { -private boolean hasItem(Player player, int type, String string) public void readInput(Player player, int levelReq, int type, int amountToMake) -private void checkBar(Player player, int level, int amountToMake, int type) public static void smithItem(Player player, int addItem, int removeItem, int removeItem2, int timesToMake, int XP) public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/SmithingInterface.md b/docs/Server/classes/SmithingInterface.md index 9b27a5a8c..ac0a78f90 100644 --- a/docs/Server/classes/SmithingInterface.md +++ b/docs/Server/classes/SmithingInterface.md @@ -10,7 +10,4 @@ Smithing Interface helper class. public class SmithingInterface { public SmithingInterface(Player player) public void showSmithInterface(int itemId) -private void makeRuneInterface(Player c) -private void makeAddyInterface(Player c) -private void makeMithInterface(Player c) ``` diff --git a/docs/Server/classes/SpecialPlantOne.md b/docs/Server/classes/SpecialPlantOne.md index 325fea6f5..d2ed3eb50 100644 --- a/docs/Server/classes/SpecialPlantOne.md +++ b/docs/Server/classes/SpecialPlantOne.md @@ -9,8 +9,51 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class SpecialPlantOne { public SpecialPlantOne(Player player) -private static Map saplings = new HashMap(); public static SpecialPlantData forId(int saplingId) public int getSapplingId() public int getHarvestId() +public int getSeedAmount() +public int getLevelRequired() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public int getCheckHealthState() +public double getCheckHealthXp() +public int getDiseaseDiffValue() +public int getDeathDiffValue() +public static SpecialPlantFieldsData forIdPosition(int x, int y) +public int getSpecialPlantsIndex() +public Point[] getSpecialPlantPosition() +public int getSaplingd() +public static InspectData forId(int saplingId) +public int getSeedId() +public String[][] getMessages() +public void updateSpecialPlants() +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSapling(int objectX, int objectY, final int saplingId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvestOrCheckHealth(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public void lowerStage(int index, int timer) +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/SpecialPlantTwo.md b/docs/Server/classes/SpecialPlantTwo.md index 17b79acd7..ee8c5fb6a 100644 --- a/docs/Server/classes/SpecialPlantTwo.md +++ b/docs/Server/classes/SpecialPlantTwo.md @@ -9,8 +9,51 @@ Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this ```java public class SpecialPlantTwo { public SpecialPlantTwo(Player player) -private static Map seeds = new HashMap(); public static SpecialPlantData forId(int seedId) public int getSeedId() public int getHarvestId() +public int getSeedAmount() +public int getLevelRequired() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getHarvestXp() +public int getStartingState() +public int getEndingState() +public int getCheckHealthState() +public double getCheckHealthXp() +public int getDiseaseDiffValue() +public int getDeathDiffValue() +public static SpecialPlantFieldsData forIdPosition(int x, int y) +public int getSpecialPlantsIndex() +public Point[] getSpecialPlantPosition() +public int getSeedId() +public static InspectData forId(int seedId) +public int getSeedId() +public String[][] getMessages() +public void updateSpecialPlants() +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSeeds(int objectX, int objectY, final int seedId) +public void execute(CycleEventContainer container) +public void stop() +public boolean harvestOrCheckHealth(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public void lowerStage(int index, int timer) +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean curePlant(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkIfRaked(int objectX, int objectY) ``` diff --git a/docs/Server/classes/Specials.md b/docs/Server/classes/Specials.md index d29a2780c..844ee1340 100644 --- a/docs/Server/classes/Specials.md +++ b/docs/Server/classes/Specials.md @@ -9,8 +9,9 @@ Specials helper class. ```java public class Specials { public Specials(Player player2) -private int getWeapon() -private double getSpecDamage() -private double getSpecAccuracy() -private double getSpecAmount() +public static HashMap specialAttack = new HashMap(); +public void activateSpecial(int weapon, Client other, int i) +public void handleGmaul() +public double specAmount() +public static void specialClicking(Player player2, int actionButtonId) ``` diff --git a/docs/Server/classes/SpellTeleport.md b/docs/Server/classes/SpellTeleport.md index 42a9fe876..e762e6d0c 100644 --- a/docs/Server/classes/SpellTeleport.md +++ b/docs/Server/classes/SpellTeleport.md @@ -13,4 +13,8 @@ public int getButtonId() public int getDestX() public int getDestY() public int getDestZ() +public int[][] getRequiredRunes() +public double getExperienceGained() +public String getType() +public static SpellTeleport forButtonId(int id) ``` diff --git a/docs/Server/classes/Stalls.md b/docs/Server/classes/Stalls.md index 750b9d1c9..d5ce25cbf 100644 --- a/docs/Server/classes/Stalls.md +++ b/docs/Server/classes/Stalls.md @@ -8,9 +8,14 @@ Stalls helper class. ```java public class Stalls { -private stallData(final int objectId, final int levelReq, final double xp, final int face, final int[]... stalls) public int getObject() public int getLevel() public double getXp() public int getFace() +public int[][] getStalls() +public static int r(int random) +public static boolean isObject(int object) +public static void attemptStall(final Player p, final int objectId, final int x, final int y) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/StatefulFrameDecoder.md b/docs/Server/classes/StatefulFrameDecoder.md index 9a37bfadd..93b683240 100644 --- a/docs/Server/classes/StatefulFrameDecoder.md +++ b/docs/Server/classes/StatefulFrameDecoder.md @@ -10,6 +10,4 @@ A stateful implementation of a {@link ByteToMessageDecoder} which may be extende * current state is tracked by this class and is a user-specified enumeration. public StatefulFrameDecoder(T state) public final void setState(T state) -protected final void decode(ChannelHandlerContext ctx, ByteBuf in, List out) throws Exception -protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List out, T state) throws Exception; ``` diff --git a/docs/Server/classes/Stream.md b/docs/Server/classes/Stream.md index 30f78e7be..7078ea038 100644 --- a/docs/Server/classes/Stream.md +++ b/docs/Server/classes/Stream.md @@ -13,4 +13,34 @@ public Stream(byte abyte0[]) public void writeByteA(int i) public void writeByteS(int i) public void writeByteC(int i) +public void writeWordBigEndianA(int i) +public void writeWordA(int i) +public void writeWordBigEndian_dup(int i) +public int readDWord_v1() +public int readDWord_v2() +public void writeDWord_v1(int i) +public void writeDWord_v2(int i) +public void writeBytes_reverse(byte abyte0[], int i, int j) +public void writeBytes_reverseA(byte abyte0[], int i, int j) +public void createFrame(int id) +public void createFrameVarSize(int id) +public void createFrameVarSizeWord(int id) +public void endFrameVarSize() +public void endFrameVarSizeWord() +public void writeByte(int i) +public void writeWord(int i) +public void writeWordBigEndian(int i) +public void write3Byte(int i) +public void writeDWord(int i) +public void writeDWordBigEndian(int i) +public void writeQWord(long l) +public void writeString(java.lang.String s) +public void writeBytes(byte abyte0[], int i, int j) +public void writeFrameSize(int i) +public void writeFrameSizeWord(int i) +public void initBitAccess() +public void writeBits(int numBits, int value) +public void finishBitAccess() +public void ensureCapacity(int len) +public void reset() ``` diff --git a/docs/Server/classes/StreamUtil.md b/docs/Server/classes/StreamUtil.md index 860851528..9dfc191ba 100644 --- a/docs/Server/classes/StreamUtil.md +++ b/docs/Server/classes/StreamUtil.md @@ -10,5 +10,4 @@ Contains utility methods for {@link InputStream}s and {@link OutputStream}s. @a public final class StreamUtil { public static String readString(InputStream input) throws IOException public static void writeString(OutputStream output, String string) throws IOException -private StreamUtil() ``` diff --git a/docs/Server/classes/Stringing.md b/docs/Server/classes/Stringing.md index bca8480a8..5b11fb5a7 100644 --- a/docs/Server/classes/Stringing.md +++ b/docs/Server/classes/Stringing.md @@ -9,8 +9,12 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/fletchin ```java public class Stringing { public static Data forId(int itemId, int usedWith) -private Data(int item1, int item2, int product, int level, double xp) public int getItem1() public int getItem2() public int getProduct() +public int getLevel() +public double getXp() +public static boolean StringBow(final Player player, int itemUsed, int usedWith) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/Swarm.md b/docs/Server/classes/Swarm.md index 38e18382d..60b2135fe 100644 --- a/docs/Server/classes/Swarm.md +++ b/docs/Server/classes/Swarm.md @@ -8,7 +8,6 @@ Swarm Event @author Andrew (I'm A Boss on Rune-Server, Mr Extremez on Moparscape ```java public class Swarm { -private static int checkStats(Player c, boolean bot) public static void spawnSwarm(Player c) public static void checkBot(Client client) ``` diff --git a/docs/Server/classes/Telekinetic.md b/docs/Server/classes/Telekinetic.md index fc8501de6..9ddf5ce90 100644 --- a/docs/Server/classes/Telekinetic.md +++ b/docs/Server/classes/Telekinetic.md @@ -8,9 +8,18 @@ Telekinetic helper class. ```java public class Telekinetic { -private Maze(int minX, int minY, int height, int startX, int startY, int endX, int endY) public static Maze getMaze(int x, int y, int h) public Point calcDirection(Player player) public Point getNewPos(int curX, int curY, int dirX, int dirY) -private Random random = new Random(); +public Telekinetic(Player c) +public void moveStatue(int itemX, int itemY) +public void execute(CycleEventContainer container) +public void stop() +public void goToMaze() +public void execute(CycleEventContainer container) +public void stop() {} +public void observeStatue(int itemX, int itemY) +public void resetStatue(int itemX, int itemY) +public static void process() +public static void updateInterface(Player player) ``` diff --git a/docs/Server/classes/TextUtil.md b/docs/Server/classes/TextUtil.md index c6d292bd1..e8775ba91 100644 --- a/docs/Server/classes/TextUtil.md +++ b/docs/Server/classes/TextUtil.md @@ -12,5 +12,4 @@ public static String capitalize(String string) public static int compress(String in, byte[] out) public static String filterInvalidCharacters(String str) public static String decompress(byte[] in, int len) -private TextUtil() ``` diff --git a/docs/Server/classes/ThieveOther.md b/docs/Server/classes/ThieveOther.md index ec6932629..c8df9d6c4 100644 --- a/docs/Server/classes/ThieveOther.md +++ b/docs/Server/classes/ThieveOther.md @@ -13,4 +13,5 @@ public static void pickLock(final Player client, int level, final double exp, fi public void execute(CycleEventContainer container) public void stop() public static boolean playerHasRequiredThievingLevel(final Player client, int level) +public static boolean thievingEnabled(final Player client) ``` diff --git a/docs/Server/classes/ThreadUtil.md b/docs/Server/classes/ThreadUtil.md index 05187c07e..b6cf4c7fa 100644 --- a/docs/Server/classes/ThreadUtil.md +++ b/docs/Server/classes/ThreadUtil.md @@ -9,7 +9,6 @@ A static utility class which provides ease of use functionality for {@link Threa ```java * A static utility class which provides ease of use functionality for {@link Thread}s public static final int AVAILABLE_PROCESSORS = Runtime.getRuntime().availableProcessors(); -private static final Logger logger = Logger.getLogger(ThreadUtil.class.getSimpleName()); public static ThreadFactory create(String name) public static ThreadFactory create(String name, int priority) public static ThreadFactory create(String name, int priority, UncaughtExceptionHandler handler) diff --git a/docs/Server/classes/Tile.md b/docs/Server/classes/Tile.md index a50cc3c4a..d484754cf 100644 --- a/docs/Server/classes/Tile.md +++ b/docs/Server/classes/Tile.md @@ -13,4 +13,17 @@ public Tile build() public void setAttributes(int attributes) public void setHeight(int height) public void setOverlay(int overlay) +public void setOverlayOrientation(int orientation) +public void setOverlayType(int type) +public void setPosition(int x, int y, int height) +public void setUnderlay(int underlay) +public static Builder builder(int x, int y, int height) +public int getAttributes() +public int getHeight() +public int getOverlay() +public int getOverlayOrientation() +public int getOverlayType() +public int getUnderlay() +public int getX() +public int getY() ``` diff --git a/docs/Server/classes/TileControl.md b/docs/Server/classes/TileControl.md index 2dcf07da1..95c595f9b 100644 --- a/docs/Server/classes/TileControl.md +++ b/docs/Server/classes/TileControl.md @@ -13,4 +13,11 @@ public static Tile[] getTiles(Client client) public static Tile[] getTiles(Npc npc) public static int calculateDistance(Client client, Client following) public static int calculateDistance(Npc npc, Client following) +public static int calculateDistance(Client client, Npc npc) +public static int calculateDistance(Tile location, Client other) +public static int calculateDistance(Tile location, Npc other) +public static int calculateDistance(int[] location, int[] other) +public static int[] currentLocation(Client client) +public static int[] currentLocation(Npc npc) +public static int[] currentLocation(Tile tileLocation) ``` diff --git a/docs/Server/classes/TileUtils.md b/docs/Server/classes/TileUtils.md index 28974eba1..047375f17 100644 --- a/docs/Server/classes/TileUtils.md +++ b/docs/Server/classes/TileUtils.md @@ -9,8 +9,4 @@ Contains tile-related utility methods. @author Johnny @author Major ```java public final class TileUtils { public static int calculateHeight(int x, int z) -private static int computeHeight(int x, int z) -private static int interpolate(int a, int b, int theta, int reciprocal) -private static int interpolatedNoise(int x, int z, int reciprocal) -private static int noise(int x, int z) ``` diff --git a/docs/Server/classes/TipMaking.md b/docs/Server/classes/TipMaking.md index f8214f27b..beff1d31d 100644 --- a/docs/Server/classes/TipMaking.md +++ b/docs/Server/classes/TipMaking.md @@ -9,8 +9,13 @@ Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/fletchin ```java public class TipMaking { public static Data forId(int itemUsed, int usedWith) -private Data(int item1, int item2, int product, int quantity, int level, double xp) public int getItem1() public int getItem2() public int getProduct() +public int getQuantity() +public int getLevel() +public double getXp() +public static boolean makeTips(final Player player, int itemUsed, int usedWith) +public void execute(CycleEventContainer container) +public void stop() ``` diff --git a/docs/Server/classes/ToolLeprechaun.md b/docs/Server/classes/ToolLeprechaun.md index cd12a9a7b..ee9aa6fe5 100644 --- a/docs/Server/classes/ToolLeprechaun.md +++ b/docs/Server/classes/ToolLeprechaun.md @@ -13,4 +13,21 @@ public Item[] storeItems = { new Item(5341), new Item(5343), new Item(952), public Item[] storeItems2 = { new Item(1925), new Item(6032), public Item[] storeItemsClient = { new Item(5341), new Item(5343), public Item[] storeItems2Client = { new Item(1925), new Item(6032), +public static ToolStoreData forId(int toolId) +public static ToolStoreData forIndex(int index) +public int getToolIndex() +public int getToolId() +public int getToolConfig() +public int getToolMaxQuantity() +public int getToolFrameId() +public int getToolCountFrameId() +public String getToolName() +public void loadInterfaces() +public void handleAdditionalTools() +public void checkWateringCanQuantity() +public boolean hasWateringCanInStore() +public void updateStore() +public void storeItems(int itemId, int amount) +public void withdrawItems(int itemId, int amount) +public boolean noteItem(int itemId) ``` diff --git a/docs/Server/classes/Trading.md b/docs/Server/classes/Trading.md index 516c8b2cd..1428cc302 100644 --- a/docs/Server/classes/Trading.md +++ b/docs/Server/classes/Trading.md @@ -13,4 +13,15 @@ public CopyOnWriteArrayList offeredItems = new CopyOnWriteArrayList players = new ArrayList(); public ArrayList players_to_remove = new ArrayList(); -private final Random random_gen = new Random(); public static int getIndex(int x, int y) +public static Wall getWallByIndex(int index, boolean sinking) +public int getAvaliableWallSize() +public int[] getAvaliableWalls() +public void breakRandomWall() +public void resetWalls() +public void updateWall(int index) +public void playerUpdates() +public void onStart() +public void execute(CycleEventContainer container) +public void stop() +public void onEndLose() +public void start() +public void execute(CycleEventContainer container) +public void stop() +public void tick() +public void ripNet() +public void increaseWaterLevel() +public void fixHole(Player player, int x, int y) +public void upLadder(Player player, int obX, int obY) +public void downLadder(Player player, int obX, int obY) +public void fixNet(Player p) +public boolean doAction(Player p) +public void bail(Player p) +public void emptyBucket(Player p) +public void increaseFish() +public int end() +public void setSwimmingAnimations() +public void switchBoats() +public void startGameTimer() +public void execute(CycleEventContainer container) +public void stop() +public int chanceByLevel(Player p, int fish) +public void movePlayersLoss() +public void movePlayerWin(final ArrayList pl) +public void execute(CycleEventContainer container) +public void stop() +public ArrayList playerReward(Player p) +public boolean skillCheck(int level, int levelRequired, int itemBonus) +public WaitingRoom getWaitingRoom() +public String getWaitingRoomMessage() +public boolean inProgress() +public int getGameTime() +public void resetRewardsInterface(Player player) +public void showReward(Player player) +public void updateRewardSlot(Player player, int slot) +public int getRewardSlot(int j) ``` diff --git a/docs/Server/classes/TrawlerWaitingRoom.md b/docs/Server/classes/TrawlerWaitingRoom.md index 7daceefcf..e16246b24 100644 --- a/docs/Server/classes/TrawlerWaitingRoom.md +++ b/docs/Server/classes/TrawlerWaitingRoom.md @@ -8,9 +8,12 @@ Trawler Waiting Room helper class. ```java public class TrawlerWaitingRoom extends WaitingRoom { -private Boundary boat = new Boundary(2668,2674,3165,3185); public TrawlerWaitingRoom(Trawler trawler) public boolean startGame() public void onStart() public void onLeave(Player p) +public void onJoin(Player p) +public Boundary getLocation() +public void onTimeChange() +public boolean canStart() ``` diff --git a/docs/Server/classes/TreeSpirit.md b/docs/Server/classes/TreeSpirit.md index 2e4583a7e..e663e6b2c 100644 --- a/docs/Server/classes/TreeSpirit.md +++ b/docs/Server/classes/TreeSpirit.md @@ -8,6 +8,5 @@ Tree Spirit helper class. ```java public class TreeSpirit { -private static int checkStats(Player p) public static void spawnTreeSpirit(Player p) ``` diff --git a/docs/Server/classes/UniversalEventProvider.md b/docs/Server/classes/UniversalEventProvider.md index 3634b435c..412341bac 100644 --- a/docs/Server/classes/UniversalEventProvider.md +++ b/docs/Server/classes/UniversalEventProvider.md @@ -8,9 +8,8 @@ A universal event provider which posts, provides and deprives subscribers. @aut ```java public final class UniversalEventProvider implements EventProvider { -private final Multimap, EventSubscriber> events = ArrayListMultimap.create(); -private final EventContext context = new UniversalEventContext(); public void provideSubscriber(EventSubscriber subscriber) public void depriveSubscriber(EventSubscriber subscriber) -private void checkSubscriber(EventSubscriber subscriber, Consumer consumer) +public void post(Player player, E event) +public Multimap, EventSubscriber> getEvents() ``` diff --git a/docs/Server/classes/UpdateConstants.md b/docs/Server/classes/UpdateConstants.md index 5bb3dbe98..1fbda3e7c 100644 --- a/docs/Server/classes/UpdateConstants.md +++ b/docs/Server/classes/UpdateConstants.md @@ -1 +1,11 @@ # UpdateConstants + +Package `org.apollo.net.update`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/net/update/UpdateConstants.java`](2006Scape Server/src/main/java/org/apollo/net/update/UpdateConstants.java). + +Holds update-related constants. @author Graham + +```java +public final class UpdateConstants { +``` diff --git a/docs/Server/classes/UpdateDecoder.md b/docs/Server/classes/UpdateDecoder.md index e90eac189..d55d3f7b3 100644 --- a/docs/Server/classes/UpdateDecoder.md +++ b/docs/Server/classes/UpdateDecoder.md @@ -1 +1,11 @@ # UpdateDecoder + +Package `org.apollo.net.codec.update`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/net/codec/update/UpdateDecoder.java`](2006Scape Server/src/main/java/org/apollo/net/codec/update/UpdateDecoder.java). + +A {@link ByteToMessageDecoder} for the 'on-demand' protocol. @author Graham + +```java +public final class UpdateDecoder extends ByteToMessageDecoder { +``` diff --git a/docs/Server/classes/UpdateDispatcher.md b/docs/Server/classes/UpdateDispatcher.md index a9f58277b..e2769f30b 100644 --- a/docs/Server/classes/UpdateDispatcher.md +++ b/docs/Server/classes/UpdateDispatcher.md @@ -1 +1,14 @@ # UpdateDispatcher + +Package `org.apollo.net.update`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/net/update/UpdateDispatcher.java`](2006Scape Server/src/main/java/org/apollo/net/update/UpdateDispatcher.java). + +Dispatches update requests to worker threads. @author Graham + +```java +public final class UpdateDispatcher { +public void dispatch(Channel channel, HttpRequest request) +public void dispatch(Channel channel, JagGrabRequest request) +public void dispatch(Channel channel, OnDemandRequest request) +``` diff --git a/docs/Server/classes/UpdateEncoder.md b/docs/Server/classes/UpdateEncoder.md index 786c92869..a780fe0c7 100644 --- a/docs/Server/classes/UpdateEncoder.md +++ b/docs/Server/classes/UpdateEncoder.md @@ -1 +1,11 @@ # UpdateEncoder + +Package `org.apollo.net.codec.update`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/net/codec/update/UpdateEncoder.java`](2006Scape Server/src/main/java/org/apollo/net/codec/update/UpdateEncoder.java). + +A {@link MessageToMessageEncoder} for the 'on-demand' protocol. @author Graham + +```java +public final class UpdateEncoder extends MessageToMessageEncoder { +``` diff --git a/docs/Server/classes/UpdateSession.md b/docs/Server/classes/UpdateSession.md index ff04f6f44..5fc1e2d0e 100644 --- a/docs/Server/classes/UpdateSession.md +++ b/docs/Server/classes/UpdateSession.md @@ -1 +1,14 @@ # UpdateSession + +Package `org.apollo.game.session`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/game/session/UpdateSession.java`](2006Scape Server/src/main/java/org/apollo/game/session/UpdateSession.java). + +An update session. @author Graham + +```java +public final class UpdateSession extends Session { +public UpdateSession(Channel channel) +public void destroy() +public void messageReceived(Object message) +``` diff --git a/docs/Server/classes/UseItem.md b/docs/Server/classes/UseItem.md index d062906d8..c8679e338 100644 --- a/docs/Server/classes/UseItem.md +++ b/docs/Server/classes/UseItem.md @@ -1 +1,14 @@ # UseItem + +Package `com.rs2.game.items`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/items/UseItem.java`](2006Scape Server/src/main/java/com/rs2/game/items/UseItem.java). + +@author Ryan / Lmctruck30 + +```java +public class UseItem { +public static void itemOnObject(Player c, int objectID, int objectX, int objectY, int itemId) +public static void itemOnItem(Player player, int itemUsed, int useWith) +public static void itemOnNpc(final Player c, final int itemId, final int npcId, final int slot) +``` diff --git a/docs/Server/classes/UseOther.md b/docs/Server/classes/UseOther.md index 0ada44c3e..d9869d96f 100644 --- a/docs/Server/classes/UseOther.md +++ b/docs/Server/classes/UseOther.md @@ -1 +1,13 @@ # UseOther + +Package `com.rs2.game.objects.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/objects/impl/UseOther.java`](2006Scape Server/src/main/java/com/rs2/game/objects/impl/UseOther.java). + +Use Other helper class. + +```java +public class UseOther { +public static void useUp(final Player player, final int objectId) +public static void useDown(final Player player, final int objectId) +``` diff --git a/docs/Server/classes/VampyreSlayer.md b/docs/Server/classes/VampyreSlayer.md index 0ff103ecd..247a033dd 100644 --- a/docs/Server/classes/VampyreSlayer.md +++ b/docs/Server/classes/VampyreSlayer.md @@ -1 +1,12 @@ # VampyreSlayer + +Package `com.rs2.game.content.quests.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/quests/impl/VampyreSlayer.java`](2006Scape Server/src/main/java/com/rs2/game/content/quests/impl/VampyreSlayer.java). + +Vampyre Slayer @author Andrew (Mr Extremez) + +```java +public class VampyreSlayer { +public static void showInformation(Player client) +``` diff --git a/docs/Server/classes/VirtualResourceProvider.md b/docs/Server/classes/VirtualResourceProvider.md index 18817bb9a..56da2aba4 100644 --- a/docs/Server/classes/VirtualResourceProvider.md +++ b/docs/Server/classes/VirtualResourceProvider.md @@ -1 +1,14 @@ # VirtualResourceProvider + +Package `org.apollo.net.update.resource`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/net/update/resource/VirtualResourceProvider.java`](2006Scape Server/src/main/java/org/apollo/net/update/resource/VirtualResourceProvider.java). + +A {@link ResourceProvider} which maps virtual resources (such as {@code /media}) to files in an {@link IndexedFileSystem}. @author Graham + +```java +public final class VirtualResourceProvider implements ResourceProvider { +public VirtualResourceProvider(IndexedFileSystem fs) +public boolean accept(String path) throws IOException +public Optional get(String path) throws IOException +``` diff --git a/docs/Server/classes/Vote.md b/docs/Server/classes/Vote.md index 80dfc2c3b..df853fe52 100644 --- a/docs/Server/classes/Vote.md +++ b/docs/Server/classes/Vote.md @@ -1 +1,12 @@ # Vote + +Package `com.rs2.integrations.discord.commands`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Vote.java`](2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Vote.java). + +Vote helper class. + +```java +public class Vote implements MessageCreateListener { +public void onMessageCreate(MessageCreateEvent event) +``` diff --git a/docs/Server/classes/WaitingRoom.md b/docs/Server/classes/WaitingRoom.md index 945169644..9fb23addf 100644 --- a/docs/Server/classes/WaitingRoom.md +++ b/docs/Server/classes/WaitingRoom.md @@ -1 +1,30 @@ # WaitingRoom + +Package `com.rs2.game.content.minigames.trawler`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/minigames/trawler/WaitingRoom.java`](2006Scape Server/src/main/java/com/rs2/game/content/minigames/trawler/WaitingRoom.java). + +Waiting Room helper class. + +```java +public abstract class WaitingRoom { +public ArrayList waiting = new ArrayList(); +public abstract Boundary getLocation(); +public abstract boolean startGame(); +public abstract void onStart(); +public abstract void onLeave(Player player); +public abstract void onJoin(Player p); +public abstract void onTimeChange(); +public abstract boolean canStart(); +public WaitingRoom(int minutes, int minimum) +public void join(Player player) +public void leave(Player player) +public void reset() +public void startWaiting() +public void execute(CycleEventContainer container) +public void stop() +public void messageWaiting(String message) +public boolean isActive() +public void setActive(boolean active) +public int getTimeRemaining() +``` diff --git a/docs/Server/classes/Walking.md b/docs/Server/classes/Walking.md index 379fbffee..17f0f7f14 100644 --- a/docs/Server/classes/Walking.md +++ b/docs/Server/classes/Walking.md @@ -1 +1,12 @@ # Walking + +Package `com.rs2.net.packets.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/net/packets/impl/Walking.java`](2006Scape Server/src/main/java/com/rs2/net/packets/impl/Walking.java). + +Walking packet + +```java +public class Walking implements PacketType { +public void processPacket(Player player, Packet packet) +``` diff --git a/docs/Server/classes/WeaponPoison.md b/docs/Server/classes/WeaponPoison.md index ad341fa90..72acc01f4 100644 --- a/docs/Server/classes/WeaponPoison.md +++ b/docs/Server/classes/WeaponPoison.md @@ -1 +1,15 @@ # WeaponPoison + +Package `com.rs2.game.items.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/items/impl/WeaponPoison.java`](2006Scape Server/src/main/java/com/rs2/game/items/impl/WeaponPoison.java). + +Manages weapon poisoning. @author Andew added every single weapon to the enum @author Hybris writing the system + +```java +* @author Andew added every single weapon to the enum +public int getItemId() +public static HashMap weapon = new HashMap(); +public int[][] getNewItemId() +public static void execute(final Player player, int itemUse, int useWith) +``` diff --git a/docs/Server/classes/WearItem.md b/docs/Server/classes/WearItem.md index bf178f7d3..af8b7d6cc 100644 --- a/docs/Server/classes/WearItem.md +++ b/docs/Server/classes/WearItem.md @@ -1 +1,12 @@ # WearItem + +Package `com.rs2.net.packets.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/net/packets/impl/WearItem.java`](2006Scape Server/src/main/java/com/rs2/net/packets/impl/WearItem.java). + +Wear Item + +```java +public class WearItem implements PacketType { +public void processPacket(Player player, Packet packet) +``` diff --git a/docs/Server/classes/Webs.md b/docs/Server/classes/Webs.md index ea38d0939..f49be0d7b 100644 --- a/docs/Server/classes/Webs.md +++ b/docs/Server/classes/Webs.md @@ -1 +1,13 @@ # Webs + +Package `com.rs2.game.objects.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/objects/impl/Webs.java`](2006Scape Server/src/main/java/com/rs2/game/objects/impl/Webs.java). + +@author Andrew (Mr Extremez) + +```java +public class Webs { +public static boolean webs(Player player, int object) +public static void slashWeb(Player player, final int objectClickId, final int objectX, final int objectY) +``` diff --git a/docs/Server/classes/Website.md b/docs/Server/classes/Website.md index f1b0571f5..760f1010b 100644 --- a/docs/Server/classes/Website.md +++ b/docs/Server/classes/Website.md @@ -1 +1,12 @@ # Website + +Package `com.rs2.integrations.discord.commands`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Website.java`](2006Scape Server/src/main/java/com/rs2/integrations/discord/commands/Website.java). + +Website helper class. + +```java +public class Website implements MessageCreateListener { +public void onMessageCreate(MessageCreateEvent event) +``` diff --git a/docs/Server/classes/Weight.md b/docs/Server/classes/Weight.md index bb4a9dffd..df32c714e 100644 --- a/docs/Server/classes/Weight.md +++ b/docs/Server/classes/Weight.md @@ -1 +1,13 @@ # Weight + +Package `com.rs2.game.items`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/items/Weight.java`](2006Scape Server/src/main/java/com/rs2/game/items/Weight.java). + +@author somedude, credits to Galkon for item weights + +```java +public class Weight { +public static void calcWeight(Player c, int item, String action) +public static void updateWeight(Player player) +``` diff --git a/docs/Server/classes/WelcomeMessage.md b/docs/Server/classes/WelcomeMessage.md index c7c1b6440..fdbe057fe 100644 --- a/docs/Server/classes/WelcomeMessage.md +++ b/docs/Server/classes/WelcomeMessage.md @@ -1 +1,12 @@ # WelcomeMessage + +Package `com.rs2.integrations.discord`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/integrations/discord/WelcomeMessage.java`](2006Scape Server/src/main/java/com/rs2/integrations/discord/WelcomeMessage.java). + +Welcome Message helper class. + +```java +public class WelcomeMessage implements ServerMemberJoinListener { +public void onServerMemberJoin(ServerMemberJoinEvent event) +``` diff --git a/docs/Server/classes/WerewolfAgility.md b/docs/Server/classes/WerewolfAgility.md index ce880994b..380af8761 100644 --- a/docs/Server/classes/WerewolfAgility.md +++ b/docs/Server/classes/WerewolfAgility.md @@ -1 +1,15 @@ # WerewolfAgility + +Package `com.rs2.game.content.skills.agility`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/agility/WerewolfAgility.java`](2006Scape Server/src/main/java/com/rs2/game/content/skills/agility/WerewolfAgility.java). + +Gameplay logic related to the Agility skill. + +```java +public class WerewolfAgility { +public WerewolfAgility(Player player) +public boolean werewolfCourse(int objectId) +public void execute(CycleEventContainer container) +public void stop() +``` diff --git a/docs/Server/classes/WidgetContainerFirstOptionEvent.md b/docs/Server/classes/WidgetContainerFirstOptionEvent.md index 008a1bb9b..75512ebb6 100644 --- a/docs/Server/classes/WidgetContainerFirstOptionEvent.md +++ b/docs/Server/classes/WidgetContainerFirstOptionEvent.md @@ -1 +1,15 @@ # WidgetContainerFirstOptionEvent + +Package `com.rs2.event.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerFirstOptionEvent.java`](2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerFirstOptionEvent.java). + +Widget Container First Option Event helper class. + +```java +public final class WidgetContainerFirstOptionEvent implements Event { +public WidgetContainerFirstOptionEvent(int widgetId, int itemId, int itemSlot) +public int getWidgetId() +public int getItemSlot() +public int getItemId() +``` diff --git a/docs/Server/classes/WidgetContainerFourthOptionEvent.md b/docs/Server/classes/WidgetContainerFourthOptionEvent.md index e172105cf..437462f98 100644 --- a/docs/Server/classes/WidgetContainerFourthOptionEvent.md +++ b/docs/Server/classes/WidgetContainerFourthOptionEvent.md @@ -1 +1,15 @@ # WidgetContainerFourthOptionEvent + +Package `com.rs2.event.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerFourthOptionEvent.java`](2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerFourthOptionEvent.java). + +Widget Container Fourth Option Event helper class. + +```java +public final class WidgetContainerFourthOptionEvent implements Event { +public WidgetContainerFourthOptionEvent(int widgetId, int itemId, int itemSlot) +public int getWidgetId() +public int getItemSlot() +public int getItemId() +``` diff --git a/docs/Server/classes/WidgetContainerSecondOptionEvent.md b/docs/Server/classes/WidgetContainerSecondOptionEvent.md index b86ffea26..3ee0ec9af 100644 --- a/docs/Server/classes/WidgetContainerSecondOptionEvent.md +++ b/docs/Server/classes/WidgetContainerSecondOptionEvent.md @@ -1 +1,15 @@ # WidgetContainerSecondOptionEvent + +Package `com.rs2.event.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerSecondOptionEvent.java`](2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerSecondOptionEvent.java). + +Widget Container Second Option Event helper class. + +```java +public final class WidgetContainerSecondOptionEvent implements Event { +public WidgetContainerSecondOptionEvent(int widgetId, int itemId, int itemSlot) +public int getWidgetId() +public int getItemSlot() +public int getItemId() +``` diff --git a/docs/Server/classes/WidgetContainerThirdOptionEvent.md b/docs/Server/classes/WidgetContainerThirdOptionEvent.md index 62b80de0e..d6129f727 100644 --- a/docs/Server/classes/WidgetContainerThirdOptionEvent.md +++ b/docs/Server/classes/WidgetContainerThirdOptionEvent.md @@ -1 +1,15 @@ # WidgetContainerThirdOptionEvent + +Package `com.rs2.event.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerThirdOptionEvent.java`](2006Scape Server/src/main/java/com/rs2/event/impl/WidgetContainerThirdOptionEvent.java). + +Widget Container Third Option Event helper class. + +```java +public final class WidgetContainerThirdOptionEvent implements Event { +public WidgetContainerThirdOptionEvent(int widgetId, int itemId, int itemSlot) +public int getWidgetId() +public int getItemSlot() +public int getItemId() +``` diff --git a/docs/Server/classes/WildernessAgility.md b/docs/Server/classes/WildernessAgility.md index da31747eb..c7c7bbd71 100644 --- a/docs/Server/classes/WildernessAgility.md +++ b/docs/Server/classes/WildernessAgility.md @@ -1 +1,15 @@ # WildernessAgility + +Package `com.rs2.game.content.skills.agility`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/agility/WildernessAgility.java`](2006Scape Server/src/main/java/com/rs2/game/content/skills/agility/WildernessAgility.java). + +Gameplay logic related to the Agility skill. + +```java +public class WildernessAgility { +public WildernessAgility(Player player) +public boolean wildernessCourse(final int objectId) +public void execute(CycleEventContainer container) +public void stop() +``` diff --git a/docs/Server/classes/WitchsPotion.md b/docs/Server/classes/WitchsPotion.md index e452581b6..698f3f969 100644 --- a/docs/Server/classes/WitchsPotion.md +++ b/docs/Server/classes/WitchsPotion.md @@ -1 +1,12 @@ # WitchsPotion + +Package `com.rs2.game.content.quests.impl`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/quests/impl/WitchsPotion.java`](2006Scape Server/src/main/java/com/rs2/game/content/quests/impl/WitchsPotion.java). + +Witchs Potion @author Andrew (Mr Extremez) + +```java +public class WitchsPotion { +public static void showInformation(Player client) +``` diff --git a/docs/Server/classes/WoodTrees.md b/docs/Server/classes/WoodTrees.md index da2555ff9..b7fcb7df7 100644 --- a/docs/Server/classes/WoodTrees.md +++ b/docs/Server/classes/WoodTrees.md @@ -1 +1,67 @@ # WoodTrees + +Package `com.rs2.game.content.skills.farming`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/farming/WoodTrees.java`](2006Scape Server/src/main/java/com/rs2/game/content/skills/farming/WoodTrees.java). + +Created by IntelliJ IDEA. User: vayken Date: 24/02/12 Time: 20:34 To change this template use File | Settings | File Templates. + +```java +public class WoodTrees { +public WoodTrees(Player player) +public static TreeData forId(int saplingId) +public int getSaplingId() +public int getRootsId() +public int getLevelRequired() +public int[] getPaymentToWatch() +public int getGrowthTime() +public double getDiseaseChance() +public double getPlantingXp() +public double getCheckHealthXp() +public int getStartingState() +public int getEndingState() +public int getChopDownState() +public int getStumpState() +public int getTreeObjectAssociated() +public static TreeFieldsData forId(int npcId) +public static TreeFieldsData forIdPosition(int x, int y) +public int getTreeIndex() +public Point[] getTreePosition() +public int getNpcId() +public static InspectData forId(int saplingId) +public int getSaplingId() +public String[][] getMessages() +public void updateTreeStates() +public int getPlantState(int plantState) +public void doCalculations() +public void modifyStage(int i) +public void doStateCalculation(int index) +public boolean clearPatch(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean plantSapling(int objectX, int objectY, final int saplingId) +public void execute(CycleEventContainer container) +public void stop() +public boolean checkHealth(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public void respawnStumpTimer(final int index) +public void execute(CycleEventContainer container) +public void stop() +public boolean putCompost(int objectX, int objectY, final int itemId) +public void execute(CycleEventContainer container) +public void stop() +public boolean inspect(int objectX, int objectY) +public void execute(CycleEventContainer container) +public void stop() +public boolean guide(int objectX, int objectY) +public boolean pruneArea(int objectX, int objectY, int itemId) +public void execute(CycleEventContainer container) +public void stop() +public void resetTrees(int index) +public boolean cut(final int x, final int y) +public void execute(CycleEventContainer container) +public void stop() +public boolean canCut(final int x, final int y) +public boolean checkIfRaked(int objectX, int objectY) +``` diff --git a/docs/Server/classes/Woodcutting.md b/docs/Server/classes/Woodcutting.md index 45a38c433..4874f0060 100644 --- a/docs/Server/classes/Woodcutting.md +++ b/docs/Server/classes/Woodcutting.md @@ -1 +1,31 @@ # Woodcutting + +Package `com.rs2.game.content.skills.woodcutting`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/skills/woodcutting/Woodcutting.java`](2006Scape Server/src/main/java/com/rs2/game/content/skills/woodcutting/Woodcutting.java). + +Woodcutting helper class. + +```java +public class Woodcutting { +public static void repeatAnimation(final Player p) +public void execute(CycleEventContainer container) +public void stop() +public static void handleCanoe(final Player player, final int objectId) +public void execute(CycleEventContainer container) +public void execute(CycleEventContainer container) +public void stop() +public void stop() +public void fixAxe(final Player player) +public void execute(CycleEventContainer container) +public void stop() +public static void addFallenTree(Player player, int canoe) +public static boolean hasAxe(Player player) +public static void startWoodcutting(final Player p, final int objectId, final int x, final int y, final int type) +public void execute(CycleEventContainer container) +public void stop() +public static void stopWoodcutting(Player player) +public static int getTimer(treeData tree, int axe, int level) +public static boolean playerTrees(Player player, int tree) +public static void cutDownTree(int respawnTime, int objectX, int objectY, int type, int stumpID, int treeID) +``` diff --git a/docs/Server/classes/XStreamUtil.md b/docs/Server/classes/XStreamUtil.md index a7195d169..044fd1e69 100644 --- a/docs/Server/classes/XStreamUtil.md +++ b/docs/Server/classes/XStreamUtil.md @@ -1 +1,14 @@ # XStreamUtil + +Package `com.rs2.util`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/util/XStreamUtil.java`](2006Scape Server/src/main/java/com/rs2/util/XStreamUtil.java). + +XStream Util helper class. + +```java +public class XStreamUtil { +public static XStreamUtil getInstance() +public static XStream getXStream() +public static void writeXML(Object object, File file) throws IOException +``` diff --git a/docs/Server/classes/XmlNode.md b/docs/Server/classes/XmlNode.md index 264928f1e..d0de49e55 100644 --- a/docs/Server/classes/XmlNode.md +++ b/docs/Server/classes/XmlNode.md @@ -1 +1,34 @@ # XmlNode + +Package `org.apollo.util.xml`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/util/xml/XmlNode.java`](2006Scape Server/src/main/java/org/apollo/util/xml/XmlNode.java). + +A class which represents a single node in the DOM tree, maintaining information about its children, attributes, value and name. @author Graham + +```java +* A class which represents a single node in the DOM tree, maintaining information about its children, attributes, value +public XmlNode(String name) +public void addChild(XmlNode child) +public boolean containsAttribute(String name) +public String getAttribute(String name) +public int getAttributeCount() +public Set getAttributeNames() +public Set> getAttributes() +public XmlNode getChild(String name) +public int getChildCount() +public Collection getChildren() +public String getName() +public String getValue() +public Optional getOptionalValue() +public boolean hasValue() +public Iterator iterator() +public void removeAllAttributes() +public void removeAllChildren() +public void removeAttribute(String name) +public void removeChild(XmlNode child) +public void removeValue() +public void setAttribute(String name, String value) +public void setName(String name) +public void setValue(String value) +``` diff --git a/docs/Server/classes/XmlParser.md b/docs/Server/classes/XmlParser.md index 90347a018..585b48d9d 100644 --- a/docs/Server/classes/XmlParser.md +++ b/docs/Server/classes/XmlParser.md @@ -1 +1,17 @@ # XmlParser + +Package `org.apollo.util.xml`. + +Defined in [`2006Scape Server/src/main/java/org/apollo/util/xml/XmlParser.java`](2006Scape Server/src/main/java/org/apollo/util/xml/XmlParser.java). + +A simple XML parser that uses the internal {@link org.xml.sax} API to create a tree of {@link XmlNode} objects. @author Graham + +```java +public final class XmlParser { +public void characters(char[] ch, int start, int length) throws SAXException +public void endElement(String uri, String localName, String qName) throws SAXException +public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException +public XmlParser() throws SAXException +public XmlNode parse(InputStream is) throws IOException, SAXException +public XmlNode parse(Reader reader) throws IOException, SAXException +``` diff --git a/docs/Server/classes/Zombie.md b/docs/Server/classes/Zombie.md index 12bc8d384..ae1892e49 100644 --- a/docs/Server/classes/Zombie.md +++ b/docs/Server/classes/Zombie.md @@ -1 +1,12 @@ # Zombie + +Package `com.rs2.game.content.randomevents`. + +Defined in [`2006Scape Server/src/main/java/com/rs2/game/content/randomevents/Zombie.java`](2006Scape Server/src/main/java/com/rs2/game/content/randomevents/Zombie.java). + +Zombie helper class. + +```java +public class Zombie { +public static void spawnZombie(Player c) +``` diff --git a/python/doc_scanner.py b/python/doc_scanner.py index d3a2ff0c8..71b9540d1 100644 --- a/python/doc_scanner.py +++ b/python/doc_scanner.py @@ -1,4 +1,5 @@ import os +import argparse class DocScanner: """Utility to check which documentation files have been populated.""" @@ -38,6 +39,11 @@ def unprocessed(self): return sorted(all_classes - self.processed()) if __name__ == '__main__': - scanner = DocScanner() + parser = argparse.ArgumentParser(description='List docs missing metadata') + parser.add_argument('--docs-dir', default='docs/Server/classes', + help='Directory containing markdown class docs') + args = parser.parse_args() + + scanner = DocScanner(args.docs_dir) for class_name in scanner.unprocessed(): print(class_name) diff --git a/python/populate_server_docs.py b/python/populate_server_docs.py index c507a38b3..bc142d734 100644 --- a/python/populate_server_docs.py +++ b/python/populate_server_docs.py @@ -1,10 +1,18 @@ import os import re import sys -from doc_scanner import DocScanner +import argparse -DOCS_DIR = 'docs/Server/classes' -SRC_ROOT = '2006Scape Server/src/main/java' +parser = argparse.ArgumentParser(description='Populate class documentation') +parser.add_argument('--docs-dir', default='docs/Server/classes', + help='Directory of markdown class docs') +parser.add_argument('--src-root', default='2006Scape Server/src/main/java', + help='Root directory of Java sources') +parser.add_argument('files', nargs='*', help='Optional list of markdown files') +args = parser.parse_args() + +DOCS_DIR = args.docs_dir +SRC_ROOT = args.src_root def find_java(class_name): target = class_name + '.java' @@ -36,12 +44,10 @@ def parse_java(java_path): class_decl = stripped start = i + 1 break - method_pattern = re.compile(r'^\s*(public|protected|private).*\(.*\).*') + method_pattern = re.compile(r'^\s*public\s+.*\(.*\)') for line in lines[start:]: if method_pattern.match(line): methods.append(re.sub(r'\s*\{\s*$', '', line.strip())) - if len(methods) >= 5: - break return package, javadoc, class_decl, methods def default_description(class_name): @@ -59,19 +65,17 @@ def default_description(class_name): base = re.sub(r'([a-z])([A-Z])', r'\1 \2', class_name) return f'{base} helper class.' -scanner = DocScanner(DOCS_DIR) - -files = sys.argv[1:] +files = args.files if not files: - files = [os.path.join(DOCS_DIR, f'{name}.md') for name in scanner.unprocessed()] + files = [os.path.join(DOCS_DIR, name) + for name in os.listdir(DOCS_DIR) + if name.endswith('.md')] if not files: print('No documentation files to update.') sys.exit(0) for md in files: - if scanner.is_processed_file(md): - continue class_name = os.path.splitext(os.path.basename(md))[0] java_path = find_java(class_name) if not java_path: