Npc

class Npc(accessor: INpc?) : Actor<INpc> , Identifiable, Actionable, Nillable<Npc>

Types

Companion

object Companion

Functions

actions

open override fun actions(): List<String>

The current actions for the entity.

animation

fun animation(): Int

animationCycle

fun animationCycle(): Int

animationDelay

fun animationDelay(): Int

animationFrame

fun animationFrame(): Int

basePoint

open override fun basePoint(): Point

{@inheritDoc}

boundingModel

fun boundingModel(): BoundingModel?

Gets the current bounding model

fun boundingModel(boundingModel: BoundingModel?)

Sets the bounding model

fun boundingModel(expectedModel: BoundingModel?, boundingModel: BoundingModel?)

Compares and sets the bounding model

bounds

open override fun bounds(arr: IntArray?)

Sets the boundaries of this entity utilizing an array.

open override fun bounds(x1: Int, x2: Int, y1: Int, y2: Int, z1: Int, z2: Int)

Sets the boundaries of this entity.

calculateScreenPosition

open override fun calculateScreenPosition(): Callable<Point>

centerPoint

open override fun centerPoint(): Point

{@inheritDoc}

click

open override fun click(): Boolean

open override fun click(action: String?): Boolean

open override fun click(action: String?, option: String?): Boolean

open override fun click(f: Filter<MenuCommand>, useMenu: Boolean): Boolean

{@inheritDoc}

open override fun click(f: (MenuCommand) -> Boolean): Boolean

contains

open operator override fun contains(point: Point?): Boolean

Whether or not the entity contains the point.

doSetBounds

fun doSetBounds(arr: IntArray?): Filter<Interactable?>

downscale

open fun downscale(downscale: Boolean): Actor<INpc>

draw

open override fun draw(g: Graphics)

Renders the entity within the viewport at alpha = 255

equals

open operator override fun equals(o: Any?): Boolean

facingTile

open fun facingTile(): Tile

floor

fun floor(): Int

getHeight

open fun getHeight(): Int

hashCode

open override fun hashCode(): Int

healthBarVisible

open fun healthBarVisible(): Boolean

Whether or not the entity has a health bar displayed over their head. This can be used to determine whether or not the entity is currently in combat.

healthPercent

open fun healthPercent(): Int

The current percent of the health bar.

height

fun height(): Int

hull

open fun hull(): Polygon

id

open override fun id(): Int

The identifier of this entity

idleAnimation

fun idleAnimation(): Int

inMotion

open fun inMotion(): Boolean

Whether or not the entity is currently in motion.

interact

open override fun interact(f: (MenuCommand) -> Boolean): Boolean

open override fun interact(action: String?): Boolean

open override fun interact(f: Filter<MenuCommand>): Boolean

open override fun interact(f: (MenuCommand) -> Boolean, useMenu: Boolean): Boolean

open override fun interact(action: String?, useMenu: Boolean): Boolean

open override fun interact(action: String?, option: String?): Boolean

open override fun interact(f: Filter<MenuCommand>, useMenu: Boolean): Boolean

open override fun interact(action: String?, option: String?, useMenu: Boolean): Boolean

{@inheritDoc}

interacting

open fun interacting(): Actor<*>

The current entity of which this entity is interacting with. If the client is not loaded or there is no entity being interacted with, this will return Nil.

interactingIndex

open fun interactingIndex(): Int

inViewport

open override fun inViewport(): Boolean

{@inheritDoc}

open override fun inViewport(checkIfObstructed: Boolean): Boolean

Returns true if the object is currently rendered in the viewport.

isRendered

open fun isRendered(): Boolean

localX

open override fun localX(): Int

{@inheritDoc}

localY

open override fun localY(): Int

{@inheritDoc}

model

open fun model(): Model?

Load the model from the cache

modelCenterPoint

open fun modelCenterPoint(): Point

Get the center point of the model

modelHeight

open fun modelHeight(): Int?

modelOrientations

open override fun modelOrientations(): IntArray?

The orientations of the entity

movementAnimation

fun movementAnimation(): Int

movementAnimationCycle

fun movementAnimationCycle(): Int

movementAnimationFrame

fun movementAnimationFrame(): Int

name

open override fun name(): String

nextPoint

open override fun nextPoint(): Point

The next game screen point of the entity.

nil

open override fun nil(): Npc

A "null" instance. An object with no function. All methods will not evaluate to anything.

orientation

fun orientation(): Int

overheadMessage

open fun overheadMessage(): String?

The current message which appears above the head of the entity.

reachable

open fun reachable(): Boolean

Whether or not the Locatable can be reached. If the tile is blocked, the nearest unblocked tile will be used.

relative

open fun relative(): Int

renderables

open override fun renderables(): Array<IRenderable>

renderHeight

fun renderHeight(): Int

speed

fun speed(): Int

spotAnimation

fun spotAnimation(): Int

spotAnimationCycle

fun spotAnimationCycle(): Int

spotAnimationFrame

fun spotAnimationFrame(): Int

tile

open override fun tile(): Tile

The current location of the entity.

tileHeight

open fun tileHeight(): Int?

triangles

open override fun triangles(): Array<Polygon>

The translated model triangles.

useHull

open fun useHull(useHull: Boolean): Actor<INpc>

valid

open override fun valid(): Boolean

x

fun x(): Int

y

fun y(): Int

Properties

actions

val actions: List<String>

boundingModel

var boundingModel: AtomicReference<BoundingModel?>

combatLevel

open override val combatLevel: Int

config

val config: CacheNpcConfig?

downscale

open override var downscale: Boolean

id

val id: Int

name

open override val name: String

useHull

open override var useHull: Boolean