runelite-api: Correct WallObject documentation

This commit is contained in:
Max Weber
2019-05-12 23:36:19 -06:00
parent 6dd1921bfd
commit a45ad0c4a6

View File

@@ -25,28 +25,33 @@
package net.runelite.api; package net.runelite.api;
/** /**
* Represents the wall of a tile, which is an un-passable boundary. * Represents one or two walls on a tile
*/ */
public interface WallObject extends TileObject public interface WallObject extends TileObject
{ {
/** /**
* Gets the first orientation of the wall. * A bitfield with the orientation of a wall
* * 1 = East
* @return the first orientation, 0-2048 where 0 is north * 2 = North
* 4 = West
* 8 = South
*/ */
int getOrientationA(); int getOrientationA();
/** /**
* Gets the second orientation value of the wall. * A bitfield containing the orientation of the second wall on this tile,
* * or 0 if there is no second wall.
* @return the second orientation, 0-2048 where 0 is north * @see #getOrientationA
*/ */
int getOrientationB(); int getOrientationB();
/** /**
* Gets the boundary configuration of the wall. * A bitfield containing various flags:
* * <pre>{@code
* @return the boundary configuration * object type id = bits & 0x20
* orientation (0-3) = bits >>> 6 & 3
* supports items = bits >>> 8 & 1
* }</pre>
*/ */
int getConfig(); int getConfig();