simple.api.interfaces

Interface SimpleLocatable

All Known Implementing Classes:

SimpleActor, SimpleGameObject, SimpleGraphicsObject, SimpleGroundItem, SimpleGroundObject, SimpleLocalPlayer, SimpleNpc, SimplePlayer, SimpleProjectile, SimpleSceneObject, SimpleWallDecoration, SimpleWallObject, WorldPoint

public interface SimpleLocatable

Created by Seth on Aug 24, 2020 at 2:10:40 AM

Author:

Seth Davis

Method Summary

Modifier and Type	Method and Description
default int	distanceTo(SimpleLocatable to) Distance to object {to}
WorldPoint	getLocation() Position in world of object
default boolean	within(WorldArea area) If object is inside an area
default boolean	withinRange(SimpleLocatable to, int range) If object is within {range} of {to}

Method Detail

getLocation

WorldPoint getLocation()

Position in world of object

Returns:

- Worldpoint of the locatable wrapper

within

default boolean within(WorldArea area)

If object is inside an area

Parameters:

area - - area to check

Returns:

- {true} inside {false} outside

withinRange

default boolean withinRange(SimpleLocatable to,
                            int range)

If object is within {range} of {to}

Parameters:

to - - object to check

range - - range to check within

Returns:

- {true} within range {false} outside range

distanceTo

default int distanceTo(SimpleLocatable to)

Distance to object {to}

Parameters:

to - - object to check against

Returns:

- 2D distance to {to} tileafte