GameObject

class GameObject(obj: BasicObject<*>?, type: GameObject.Type) : Interactive, Nameable, InteractableEntity, Identifiable, Validatable, Actionable, Modelable<GameObject> , Nillable<GameObject> , Emittable<ObjectAction>

GameObject

Constructors

GameObject

fun GameObject(obj: BasicObject<*>?, type: GameObject.Type)

Types

Companion

object Companion

StoredConfig

data class StoredConfig(config: IObjectConfig?)

Type

enum Type : Enum<GameObject.Type>

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.

createAction

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

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

doSetBounds

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

downscale

open fun downscale(downscale: Boolean): GameObject

draw

open override fun draw(g: Graphics)

Renders the entity within the viewport at alpha = 255

dynamicObject

fun dynamicObject(): DynamicObject

equals

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

getModelCacheId

fun getModelCacheId(): Long

getObjectsTopLeftTile

fun getObjectsTopLeftTile(tile: Tile, xSize: Int, ySize: Int): Tile

Gets the top left tile of this gameobject.

getWalkableNeighbours

fun getWalkableNeighbours(allowSelf: Boolean = true): List<Tile>

Gets North/east/west/south neighbours. Did not get diagonal since gameobjects make it painful to check since you gameobjects don't let you check game object flags going out and coming since they are unwalkable.

hashCode

open override fun hashCode(): Int

height

fun height(): Int

hull

open fun hull(): Polygon

id

open override fun id(): Int

The identifier of this entity

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}

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}

mainId

fun mainId(): Int

meshIds

fun meshIds(): IntArray

meta

fun meta(): Int

model

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

modifiedColors

fun modifiedColors(): ShortArray

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

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

orientation

fun orientation(): Int

originalColors

fun originalColors(): ShortArray

reachable

open override fun reachable(): Boolean

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

relative

fun relative(): Int

renderables

open override fun renderables(): Array<IRenderable>

tile

open override fun tile(): Tile

The current location of the entity.

tileHeight

open override fun tileHeight(): Int?

toString

open override fun toString(): String

triangles

open override fun triangles(): Array<Polygon>

The translated model triangles.

type

fun type(): GameObject.Type

useHull

open fun useHull(useHull: Boolean): GameObject

valid

open override fun valid(): Boolean

width

fun width(): Int

Properties

boundingModel

var boundingModel: AtomicReference<BoundingModel?>

downscale

open override var downscale: Boolean = true

name

val name: String

tile

type

val type: GameObject.Type

useHull

open override var useHull: Boolean = true

Extensions

canUseDoor

fun GameObject.canUseDoor(): Boolean

isDoor

fun GameObject.isDoor(): Boolean

isRockfall

fun GameObject.isRockfall(): Boolean