simple.api.coords

Class WorldPoint

java.lang.Object

simple.api.coords.WorldPoint

All Implemented Interfaces:

SimpleLocatable, simple.api.TileFlags

public class WorldPoint
extends java.lang.Object
implements simple.api.TileFlags, SimpleLocatable

Created by Seth on Apr 9, 2021 at 11:55:31 PM

Author:

Seth Davis

Field Summary

Fields

Modifier and Type	Field and Description
static WorldPoint	NIL
int	plane
int	x
int	y

Fields inherited from interface simple.api.TileFlags

BLOCKED_TILE, OBJECT_TILE, UNKNOWN, UNLOADED_TILE, WALL_EAST, WALL_NORTH, WALL_NORTHEAST, WALL_NORTHWEST, WALL_SOUTH, WALL_SOUTHEAST, WALL_SOUTHWEST, WALL_WEST

Constructor Summary

Constructors

Constructor and Description
WorldPoint(int x, int y)
WorldPoint(int x, int y, int plane)

Method Summary

Modifier and Type	Method and Description
WorldPoint	derrive(int dx, int dy)
double	distanceTo(WorldPoint point)
double	distanceTo2D(WorldPoint point)
WorldPoint	dx(int dx) Offsets the x-axis coordinate by the passed value.
WorldPoint	dy(int dy) Offsets the y-axis coordinate by the passed value.
WorldPoint	dz(int dz) Offsets the plane by the passed value.
boolean	equals(java.lang.Object obj)
static WorldPoint	fromLocal(SimpleClient client, int x, int y) Gets the coordinate of the tile that contains the passed local point.
static WorldPoint	fromLocal(SimpleClient client, int x, int y, int plane) Gets the coordinate of the tile that contains the passed local point.
static WorldPoint	fromLocal(SimpleClient client, LocalPoint local) Gets the coordinate of the tile that contains the passed local point.
static WorldPoint	fromRegion(int regionId, int regionX, int regionY, int plane) Converts the passed region ID and coordinates to a world coordinate
static WorldPoint	fromScene(SimpleClient client, int x, int y, int plane) Converts the passed scene coordinates to a world space
WorldPoint	getLocation() Position in world of object
int	getPlane()
int	getRegionID() Gets the ID of the region containing this tile.
int	getRegionX() Gets the X-axis coordinate of the region coordinate
int	getRegionY() Gets the Y-axis coordinate of the region coordinate
int	getX()
int	getY()
int	hashCode()
boolean	isInScene(SimpleClient client) Checks whether this tile is located in the current scene.
static boolean	isInScene(SimpleClient client, int x, int y) Checks whether a tile is located in the current scene.
boolean	isObjectTile(ClientContext ctx) Determines if this tile is an object tile
boolean	isReachable(ClientContext ctx) Determines if this tile is reachable
boolean	isReachable(ClientContext ctx, boolean isObject) Determines if this tile is reachable
boolean	isWalkable(ClientContext ctx) Determines if this tile is walkable
boolean	onMap()
java.lang.String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface simple.api.interfaces.SimpleLocatable

distanceTo, within, withinRange

Field Detail

x

public int x

y

public int y

plane

public int plane

NIL

public static final WorldPoint NIL

Constructor Detail

WorldPoint

public WorldPoint(int x,
                  int y)

WorldPoint

public WorldPoint(int x,
                  int y,
                  int plane)

Method Detail

fromLocal

public static WorldPoint fromLocal(SimpleClient client,
                                   LocalPoint local)

Gets the coordinate of the tile that contains the passed local point.

Parameters:

client - the client

local - the local coordinate

Returns:

the tile coordinate containing the local point

fromLocal

public static WorldPoint fromLocal(SimpleClient client,
                                   int x,
                                   int y)

Gets the coordinate of the tile that contains the passed local point.

Parameters:

client - the client

x - the local x-axis coordinate

y - the local x-axis coordinate

Returns:

the tile coordinate containing the local point

fromLocal

public static WorldPoint fromLocal(SimpleClient client,
                                   int x,
                                   int y,
                                   int plane)

Gets the coordinate of the tile that contains the passed local point.

Parameters:

client - the client

x - the local x-axis coordinate

y - the local x-axis coordinate

plane - the plane

Returns:

the tile coordinate containing the local point

fromScene

public static WorldPoint fromScene(SimpleClient client,
                                   int x,
                                   int y,
                                   int plane)

Converts the passed scene coordinates to a world space

getRegionID

public int getRegionID()

Gets the ID of the region containing this tile.

Returns:

the region ID

fromRegion

public static WorldPoint fromRegion(int regionId,
                                    int regionX,
                                    int regionY,
                                    int plane)

Converts the passed region ID and coordinates to a world coordinate

getRegionX

public int getRegionX()

Gets the X-axis coordinate of the region coordinate

getRegionY

public int getRegionY()

Gets the Y-axis coordinate of the region coordinate

dx

public WorldPoint dx(int dx)

Offsets the x-axis coordinate by the passed value.

Parameters:

dx - the offset

Returns:

new instance

dy

public WorldPoint dy(int dy)

Offsets the y-axis coordinate by the passed value.

Parameters:

dy - the offset

Returns:

new instance

dz

public WorldPoint dz(int dz)

Offsets the plane by the passed value.

Parameters:

dz - the offset

Returns:

new instance

derrive

public WorldPoint derrive(int dx,
                          int dy)

distanceTo2D

public double distanceTo2D(WorldPoint point)

distanceTo

public double distanceTo(WorldPoint point)

getX

public int getX()

getY

public int getY()

getPlane

public int getPlane()

isWalkable

public boolean isWalkable(ClientContext ctx)

Determines if this tile is walkable

Returns:

true if this tile is walkable, otherwise false

isReachable

public boolean isReachable(ClientContext ctx,
                           boolean isObject)

Determines if this tile is reachable

Parameters:

isObject - whether this tile is an object tile

Returns:

true if this tile is reachable, otherwise false

isReachable

public boolean isReachable(ClientContext ctx)

Determines if this tile is reachable

Returns:

true if this tile is reachable, otherwise false

isObjectTile

public boolean isObjectTile(ClientContext ctx)

Determines if this tile is an object tile

Returns:

true if this tile is an object tile, otherwise false

onMap

public boolean onMap()

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLocation

public WorldPoint getLocation()

Description copied from interface: SimpleLocatable

Position in world of object

Specified by:

getLocation in interface SimpleLocatable

Returns:

- Worldpoint of the locatable wrapper

isInScene

public static boolean isInScene(SimpleClient client,
                                int x,
                                int y)

Checks whether a tile is located in the current scene.

Parameters:

client - the client

x - the tiles x coordinate

y - the tiles y coordinate

Returns:

true if the tile is in the scene, false otherwise

isInScene

public boolean isInScene(SimpleClient client)

Checks whether this tile is located in the current scene.

Parameters:

client - the client

Returns:

true if this tile is in the scene, false otherwise