GenericItem

abstract class GenericItem : Interactive, Identifiable, Nameable

GenericItem

Constructors

GenericItem

fun GenericItem()

Functions

actions

abstract fun actions(): List<String>

The current actions for the entity.

basePoint

abstract 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.

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

Sets the boundaries of this entity.

calculateScreenPosition

abstract fun calculateScreenPosition(): Callable<Point>

centerPoint

abstract 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

abstract operator fun contains(point: Point?): Boolean

Whether or not the entity contains the point.

cosmetic

fun cosmetic(): Boolean

Whether or not the item is a cosmetic.

doSetBounds

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

draw

abstract fun draw(g: Graphics)

Renders the entity within the viewport at alpha = 255

groundActions

fun groundActions(): List<String>

An array of the possible actions if the item were on the ground.

abstract fun id(): Int

The identifier of this entity

interact

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

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

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

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

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

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

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

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

{@inheritDoc}

inventoryActions

fun inventoryActions(): List<String>

An array of the possible actions if the item were in the inventory.

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.

members

fun members(): Boolean

Whether or not the item is a members' item.

modelId

fun modelId(): Int

The model ID of the item.

name

open override fun name(): String

nextPoint

abstract fun nextPoint(): Point

The next game screen point of the entity.

noted

fun noted(): Boolean

Whether or not the item is in banknote form.

price

fun price(): Int

stackable

fun stackable(): Boolean

Whether or not the item is stackable.

tradeable

fun tradeable(): Boolean

Whether or not the item is tradeable.

triangles

open override fun triangles(): Array<Polygon>

The translated model triangles.

valid

open override fun valid(): Boolean

value

fun value(): Int

The value of the item which would appear in most shops. This may be used to also grab the high/low alchemy value, as well.

Properties

boundingModel

var boundingModel: AtomicReference<BoundingModel?>

cachedConfig

val cachedConfig: IItemConfig?

config

val config: CacheItemConfig

Inheritors

GroundItem

Item