Tile (epicbot-api 1.0 API)

java.lang.Object
- com.epicbot.api.shared.model.Tile

All Implemented Interfaces:: Actionable, Clickable, Interactable, Locatable, Renderable, Validatable

public class Tile
extends java.lang.Object
implements Locatable, Interactable, Validatable

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`BLOCKED`
`static int`	`BLOCKED_FLOOR`
`static int`	`BLOCKED_FLOOR_DECORATION`
`static int`	`BLOCKED_LINE_OF_SIGHT`
`static int`	`BLOCKED_LINE_OF_SIGHT_EAST`
`static int`	`BLOCKED_LINE_OF_SIGHT_NORTH`
`static int`	`BLOCKED_LINE_OF_SIGHT_SOUTH`
`static int`	`BLOCKED_LINE_OF_SIGHT_WEST`
`static int`	`BLOCKED_OBJECT`
`static int`	`CLOSED`
`static int`	`OBJECT_ALLOW_RANGE`
`static int`	`OPEN`
`static int`	`WALL_ALLOW_RANGE_EAST`
`static int`	`WALL_ALLOW_RANGE_NORTH`
`static int`	`WALL_ALLOW_RANGE_NORTHEAST`
`static int`	`WALL_ALLOW_RANGE_NORTHWEST`
`static int`	`WALL_ALLOW_RANGE_SOUTH`
`static int`	`WALL_ALLOW_RANGE_SOUTHEAST`
`static int`	`WALL_ALLOW_RANGE_SOUTHWEST`
`static int`	`WALL_ALLOW_RANGE_WEST`
`static int`	`WALL_BLOCK_EAST`
`static int`	`WALL_BLOCK_NORTH`
`static int`	`WALL_BLOCK_NORTHEAST`
`static int`	`WALL_BLOCK_NORTHWEST`
`static int`	`WALL_BLOCK_SOUTH`
`static int`	`WALL_BLOCK_SOUTHEAST`
`static int`	`WALL_BLOCK_SOUTHWEST`
`static int`	`WALL_BLOCK_WEST`
`static int`	`WALL_EAST`
`static int`	`WALL_NORTH`
`static int`	`WALL_NORTHEAST`
`static int`	`WALL_NORTHWEST`
`static int`	`WALL_SOUTH`
`static int`	`WALL_SOUTHEAST`
`static int`	`WALL_SOUTHWEST`
`static int`	`WALL_WEST`

Constructor Summary

Constructors
Constructor and Description

Tile(int x, int y)

Tile(int x, int y, int plane)

Constructors
Constructor and Description
`Tile(int x, int y)`
`Tile(int x, int y, int plane)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`click(boolean rightClick)` Click on the entity.
`boolean`	`contains(java.awt.Point point)` Determines if this entity contains the given point.
`void`	`draw(java.awt.Graphics2D g2d)` Renders this entity onto the given graphics.
`boolean`	`equals(java.lang.Object obj)`
`java.util.List<java.lang.String>`	`getActions()` Gets the available actions.
`java.awt.Polygon`	`getBounds()`
`java.awt.Point`	`getCentralPoint()` Gets the central point within the entity calculated using only visible model points.
`java.awt.Polygon`	`getClickBounds()`
`Tile`	`getLocation()` Gets the tile that this entity is located on in the world.
`int`	`getPlane()` Gets the z-coordinate, also known as the floor or level.
`java.awt.Point`	`getPoint(double x, double y, int plane)`
`java.awt.Point`	`getRandomPoint()` Get a random point within the entity.
`java.awt.Point`	`getRealCentralPoint()` Gets the central point within the entity calculated using visible and non-visible model points.
`SceneOffset`	`getSceneOffset()` Gets the scene offset for this entity.
`int`	`getX()` Gets the x-coordinate.
`int`	`getY()` Gets the y-coordinate.
`boolean`	`hasAction(java.lang.String... actions)` Determines if this entity has one of the given actions.
`int`	`hashCode()`
`boolean`	`hover()` Hover on the entity.
`boolean`	`interact(int opcode)` Interacts with the entity using the specified menu action opcode.
`boolean`	`interact(java.lang.String action)` Interacts with the entity.
`boolean`	`interact(java.lang.String action, java.lang.String option)` Interacts with the entity.
`static boolean`	`isBlocked(int flag)`
`boolean`	`isValid()` Verifies whether this entity is valid and still exists.
`boolean`	`isVisible()` Gets if this entity is visible on screen.
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.epicbot.api.shared.entity.details.Locatable
canReach, canReach, canReach, derive, derive, distanceTo, distanceTo, getArea, getArea, getMapPoint, isOnMap, randomize, randomize, randomize

Methods inherited from interface com.epicbot.api.shared.entity.details.Interactable
interact, interact, interactMatch

Methods inherited from interface com.epicbot.api.shared.entity.details.Clickable
click

Methods inherited from interface com.epicbot.api.shared.entity.details.Actionable
hasActionMatch

- Field Detail
  - OPEN
```
public static final int OPEN
```
    See Also:
    
    Constant Field Values
  - CLOSED
```
public static final int CLOSED
```
    See Also:
    
    Constant Field Values
  - WALL_NORTHWEST
```
public static final int WALL_NORTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_NORTH
```
public static final int WALL_NORTH
```
    See Also:
    
    Constant Field Values
  - WALL_NORTHEAST
```
public static final int WALL_NORTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_EAST
```
public static final int WALL_EAST
```
    See Also:
    
    Constant Field Values
  - WALL_SOUTHEAST
```
public static final int WALL_SOUTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_SOUTH
```
public static final int WALL_SOUTH
```
    See Also:
    
    Constant Field Values
  - WALL_SOUTHWEST
```
public static final int WALL_SOUTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_WEST
```
public static final int WALL_WEST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_NORTHWEST
```
public static final int WALL_BLOCK_NORTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_NORTH
```
public static final int WALL_BLOCK_NORTH
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_NORTHEAST
```
public static final int WALL_BLOCK_NORTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_EAST
```
public static final int WALL_BLOCK_EAST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_SOUTHEAST
```
public static final int WALL_BLOCK_SOUTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_SOUTH
```
public static final int WALL_BLOCK_SOUTH
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_SOUTHWEST
```
public static final int WALL_BLOCK_SOUTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_BLOCK_WEST
```
public static final int WALL_BLOCK_WEST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_NORTHWEST
```
public static final int WALL_ALLOW_RANGE_NORTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_NORTH
```
public static final int WALL_ALLOW_RANGE_NORTH
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_NORTHEAST
```
public static final int WALL_ALLOW_RANGE_NORTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_EAST
```
public static final int WALL_ALLOW_RANGE_EAST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_SOUTHEAST
```
public static final int WALL_ALLOW_RANGE_SOUTHEAST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_SOUTH
```
public static final int WALL_ALLOW_RANGE_SOUTH
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_SOUTHWEST
```
public static final int WALL_ALLOW_RANGE_SOUTHWEST
```
    See Also:
    
    Constant Field Values
  - WALL_ALLOW_RANGE_WEST
```
public static final int WALL_ALLOW_RANGE_WEST
```
    See Also:
    
    Constant Field Values
  - OBJECT_ALLOW_RANGE
```
public static final int OBJECT_ALLOW_RANGE
```
    See Also:
    
    Constant Field Values
  - BLOCKED_OBJECT
```
public static final int BLOCKED_OBJECT
```
    See Also:
    
    Constant Field Values
  - BLOCKED_FLOOR_DECORATION
```
public static final int BLOCKED_FLOOR_DECORATION
```
    See Also:
    
    Constant Field Values
  - BLOCKED_FLOOR
```
public static final int BLOCKED_FLOOR
```
    See Also:
    
    Constant Field Values
  - BLOCKED
```
public static final int BLOCKED
```
    See Also:
    
    Constant Field Values
  - BLOCKED_LINE_OF_SIGHT_NORTH
```
public static final int BLOCKED_LINE_OF_SIGHT_NORTH
```
    See Also:
    
    Constant Field Values
  - BLOCKED_LINE_OF_SIGHT_EAST
```
public static final int BLOCKED_LINE_OF_SIGHT_EAST
```
    See Also:
    
    Constant Field Values
  - BLOCKED_LINE_OF_SIGHT_SOUTH
```
public static final int BLOCKED_LINE_OF_SIGHT_SOUTH
```
    See Also:
    
    Constant Field Values
  - BLOCKED_LINE_OF_SIGHT_WEST
```
public static final int BLOCKED_LINE_OF_SIGHT_WEST
```
    See Also:
    
    Constant Field Values
  - BLOCKED_LINE_OF_SIGHT
```
public static final int BLOCKED_LINE_OF_SIGHT
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - Tile
```
public Tile(int x,
            int y)
```
  - Tile
```
public Tile(int x,
            int y,
            int plane)
```
- Method Detail
  - isBlocked
```
public static boolean isBlocked(int flag)
```
  - isValid
```
public boolean isValid()
```
    Description copied from interface: Validatable
    
    Verifies whether this entity is valid and still exists.
    
    Specified by:
    
    isValid in interface Validatable
    
    Returns:
    
    true if it's still valid, false otherwise
  - getX
```
public int getX()
```
    Description copied from interface: Locatable
    
    Gets the x-coordinate.
    
    Specified by:
    
    getX in interface Locatable
    
    Returns:
    
    int
  - getY
```
public int getY()
```
    Description copied from interface: Locatable
    
    Gets the y-coordinate.
    
    Specified by:
    
    getY in interface Locatable
    
    Returns:
    
    int
  - getPlane
```
public int getPlane()
```
    Description copied from interface: Locatable
    
    Gets the z-coordinate, also known as the floor or level.
    
    Specified by:
    
    getPlane in interface Locatable
    
    Returns:
    
    int
  - getLocation
```
public Tile getLocation()
```
    Description copied from interface: Locatable
    
    Gets the tile that this entity is located on in the world.
    
    Specified by:
    
    getLocation in interface Locatable
    
    Returns:
    
    Tile
  - getSceneOffset
```
public SceneOffset getSceneOffset()
```
    Description copied from interface: Locatable
    
    Gets the scene offset for this entity.
    
    Specified by:
    
    getSceneOffset in interface Locatable
    
    Returns:
    
    SceneOffset
  - isVisible
```
public boolean isVisible()
```
    Description copied from interface: Renderable
    
    Gets if this entity is visible on screen.
    
    Specified by:
    
    isVisible in interface Renderable
    
    Returns:
    
    true if visible, false otherwise
  - click
```
public boolean click(boolean rightClick)
```
    Description copied from interface: Clickable
    
    Click on the entity.
    
    Specified by:
    
    click in interface Clickable
    
    Parameters:
    
    rightClick - true to use the right mouse button to click
    
    Returns:
    
    true if the click succeeded, false otherwise
  - interact
```
public boolean interact(java.lang.String action)
```
    Description copied from interface: Interactable
    
    Interacts with the entity.
    
    Specified by:
    
    interact in interface Interactable
    
    Parameters:
    
    action - the action to select
    
    Returns:
    
    true if the interaction succeeded, false otherwise
  - interact
```
public boolean interact(java.lang.String action,
                        java.lang.String option)
```
    Description copied from interface: Interactable
    
    Interacts with the entity.
    
    Specified by:
    
    interact in interface Interactable
    
    Parameters:
    
    action - the action to select (e.g. Bank)
    
    option - the option to select (e.g. Bank booth)
    
    Returns:
    
    true if the interaction succeeded, false otherwise
  - interact
```
public boolean interact(int opcode)
```
    Description copied from interface: Interactable
    
    Interacts with the entity using the specified menu action opcode.
    
    Specified by:
    
    interact in interface Interactable
    
    Parameters:
    
    opcode - the menu action op code (e.g. 1005 for "Walk here")
    
    Returns:
    
    true if the interaction succeeded, false otherwise
  - hover
```
public boolean hover()
```
    Description copied from interface: Clickable
    
    Hover on the entity.
    
    Specified by:
    
    hover in interface Clickable
    
    Returns:
    
    true if the hover succeeded, false otherwise
  - getCentralPoint
```
public java.awt.Point getCentralPoint()
```
    Description copied from interface: Renderable
    
    Gets the central point within the entity calculated using only visible model points.
    
    Specified by:
    
    getCentralPoint in interface Renderable
    
    Returns:
    
    Point
    
    See Also:
    
    Model.getCentralPoint(int, int, int, int, int)
  - getRealCentralPoint
```
public java.awt.Point getRealCentralPoint()
```
    Description copied from interface: Renderable
    
    Gets the central point within the entity calculated using visible and non-visible model points.
    
    Specified by:
    
    getRealCentralPoint in interface Renderable
    
    Returns:
    
    Point
    
    See Also:
    
    Model.getRealCentralPoint(int, int, int, int, int)
  - getRandomPoint
```
public java.awt.Point getRandomPoint()
```
    Description copied from interface: Renderable
    
    Get a random point within the entity.
    
    Specified by:
    
    getRandomPoint in interface Renderable
    
    Returns:
    
    Point
  - getPoint
```
public java.awt.Point getPoint(double x,
                               double y,
                               int plane)
```
  - getClickBounds
```
public java.awt.Polygon getClickBounds()
```
  - getBounds
```
public java.awt.Polygon getBounds()
```
  - contains
```
public boolean contains(java.awt.Point point)
```
    Description copied from interface: Renderable
    
    Determines if this entity contains the given point.
    
    Specified by:
    
    contains in interface Renderable
    
    Parameters:
    
    point - the point
    
    Returns:
    
    true if this entity contains the point, false otherwise
  - draw
```
public void draw(java.awt.Graphics2D g2d)
```
    Description copied from interface: Renderable
    
    Renders this entity onto the given graphics.
    
    Specified by:
    
    draw in interface Renderable
    
    Parameters:
    
    g2d - the graphics
  - 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
  - getActions
```
public java.util.List<java.lang.String> getActions()
```
    Description copied from interface: Actionable
    
    Gets the available actions.
    
    Specified by:
    
    getActions in interface Actionable
    
    Returns:
    
    list of actions
  - hasAction
```
public boolean hasAction(java.lang.String... actions)
```
    Description copied from interface: Actionable
    
    Determines if this entity has one of the given actions.
    
    Specified by:
    
    hasAction in interface Actionable
    
    Parameters:
    
    actions - one or multiple actions
    
    Returns:
    
    true if it has one of the given actions, false otherwise

Class Tile

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface com.epicbot.api.shared.entity.details.Locatable

Methods inherited from interface com.epicbot.api.shared.entity.details.Interactable

Methods inherited from interface com.epicbot.api.shared.entity.details.Clickable

Methods inherited from interface com.epicbot.api.shared.entity.details.Actionable

Field Detail

OPEN

CLOSED

WALL_NORTHWEST

WALL_NORTH

WALL_NORTHEAST

WALL_EAST

WALL_SOUTHEAST

WALL_SOUTH

WALL_SOUTHWEST

WALL_WEST

WALL_BLOCK_NORTHWEST

WALL_BLOCK_NORTH

WALL_BLOCK_NORTHEAST

WALL_BLOCK_EAST

WALL_BLOCK_SOUTHEAST

WALL_BLOCK_SOUTH

WALL_BLOCK_SOUTHWEST

WALL_BLOCK_WEST

WALL_ALLOW_RANGE_NORTHWEST

WALL_ALLOW_RANGE_NORTH

WALL_ALLOW_RANGE_NORTHEAST

WALL_ALLOW_RANGE_EAST

WALL_ALLOW_RANGE_SOUTHEAST

WALL_ALLOW_RANGE_SOUTH

WALL_ALLOW_RANGE_SOUTHWEST

WALL_ALLOW_RANGE_WEST

OBJECT_ALLOW_RANGE

BLOCKED_OBJECT

BLOCKED_FLOOR_DECORATION

BLOCKED_FLOOR

BLOCKED

BLOCKED_LINE_OF_SIGHT_NORTH

BLOCKED_LINE_OF_SIGHT_EAST

BLOCKED_LINE_OF_SIGHT_SOUTH

BLOCKED_LINE_OF_SIGHT_WEST

BLOCKED_LINE_OF_SIGHT

Constructor Detail

Tile

Tile

Method Detail

isBlocked

isValid

getX

getY

getPlane

getLocation

getSceneOffset

isVisible

click

interact

interact

interact

hover

getCentralPoint

getRealCentralPoint

getRandomPoint

getPoint

getClickBounds

getBounds

contains

draw

equals

hashCode

toString

getActions

hasAction