Item

open class Item(component: Component?, inventoryIndex: Int, id: Int, stack: Int, type: ItemType) : GenericItem, Identifiable, Nameable, Stackable, Actionable, Nillable<Item?> , Emittable<ItemAction>

Item

Constructors

Item

fun Item(component: Component, type: ItemType = ItemType.UNKNOWN)

Item

fun Item(component: Component?, id: Int, stack: Int, type: ItemType = ItemType.UNKNOWN)

Item

fun Item(component: Component?, inventoryIndex: Int, id: Int, stack: Int, type: ItemType = ItemType.UNKNOWN)

Types

Companion

object Companion

Functions

actions

open override fun actions(): List<String>

The current actions for the entity.

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

boundingRect

fun boundingRect(): Rectangle

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 bound of the item from the center. Do note that z1 and z2 are ignored.

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

component

fun component(): Component?

contains

open operator override 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.

createAction

open override fun createAction(action: String?): ItemAction

open override fun createAction(action: String?, async: Boolean): ItemAction

doSetBounds

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

draw

open override 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.

open override 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.

inventoryIndex

fun inventoryIndex(): 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.

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

open override fun nextPoint(): Point

The next game screen point of the entity.

nil

open override fun nil(): Item

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

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.

stackSize

open override fun stackSize(): Int

The quantity of the item.

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?

component

val component: Component?

config

val config: CacheItemConfig

val id: Int

inventoryIndex

val inventoryIndex: Int

stack

var stack: Int

type

var type: ItemType