kray/kray.sprites/Sprite

Sprite

interface Sprite<T>

Represents a sprite in the Kray game engine. Either 2D or 3D.

Parameters

The type of the sprite (e.g., Image for 2D sprites).

Inheritors

Sprite2D

Sprite3D

Properties

collideable

abstract var collideable: Boolean

Whether the sprite can collide with other sprites. False means it cannot.

costumes

abstract val costumes: MutableList<T>

A list of all costumes associated with this sprite.

currentCostume

open val currentCostume: T

The current costume that the sprite is wearing.

currentCostumeIndex

abstract val currentCostumeIndex: Int

The index of the current costume being used by this sprite.

isDrawn

abstract val isDrawn: Boolean

Whether the sprite has been drawn to the canvas this frame.

static

abstract var static: Boolean

Whether the sprite is affected by physics. False means it is not.

Functions

addCostume

open fun addCostume(costume: T)

Adds a costume to this sprite.

changeTo

abstract fun changeTo(index: Int)

Changes the current costume of this sprite to the one at the specified index.

nextCostume

abstract fun nextCostume()

Changes the current costume of this sprite to the next one in the list. Loops back to the first costume if currently at the last one.

previousCostume

abstract fun previousCostume()

Changes the current costume of this sprite to the previous one in the list. Loops back to the last costume if currently at the first one.

removeCostume

open fun removeCostume(costume: T)

Removes the specified costume from this sprite.

removeCostumeAt

open fun removeCostumeAt(index: Int)

Removes the costume at the specified index from this sprite.

setCostume

open fun setCostume(index: Int, costume: T)

Sets the costume at the specified index for this sprite.

setCostumes

open fun setCostumes(vararg list: T)

open fun setCostumes(list: Iterable<T>)

Sets the costumes for this sprite.

setCurrentCostume

abstract fun setCurrentCostume(costume: T)

Sets the current costume of this sprite to the specified image. If the image is not already a costume of this sprite, it is added.

switchTo

abstract fun switchTo(costume: T)

Changes the current costume of this sprite to the specified image. The costume must already be part of this sprite's costumes.