GroundItem

class GroundItem(tile: Tile, node: IItemNode?, itemPile: IItemPile?) : GenericItem, Nameable, Interactable, Identifiable, Validatable, Actionable, Locatable, InteractableEntity, Nillable<GroundItem?> , Modelable<GroundItem>

GroundItem

Constructors

GroundItem

fun GroundItem(tile: Tile, node: IItemNode?, itemPile: IItemPile?)

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

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.

cosmetic

fun cosmetic(): Boolean

Whether or not the item is a cosmetic.

doSetBounds

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

downscale

open fun downscale(downscale: Boolean): GroundItem

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

groundActions

fun groundActions(): List<String>

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

hashCode

open override fun hashCode(): Int

height

fun height(): Int

hull

open fun hull(): Polygon

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.

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

The local X position of the entity

localY

open override fun localY(): Int

The local Y position of the entity

members

fun members(): Boolean

Whether or not the item is a members' item.

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 override fun modelHeight(): Int

modelId

fun modelId(): Int

The model ID of the item.

modelOrientations

open override fun modelOrientations(): IntArray

The orientations of the entity

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(): GroundItem

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

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.

renderables

open override fun renderables(): Array<IRenderable>

stackable

fun stackable(): Boolean

Whether or not the item is stackable.

stackSize

fun stackSize(): Int

The stack size of the ItemNode.

tile

open override fun tile(): Tile

The current location of the entity.

tileHeight

open override fun tileHeight(): Int

toString

open override fun toString(): String

tradeable

fun tradeable(): Boolean

Whether or not the item is tradeable.

triangles

open override fun triangles(): Array<Polygon>

The translated model triangles.

useHull

open fun useHull(useHull: Boolean): GroundItem

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

downscale

open override var downscale: Boolean = true

matrix

val matrix: TileMatrix

tile

val tile: Tile

useHull

open override var useHull: Boolean = true