kray/kray.sprites/Sprite

Sprite

interface Sprite<T> : Positionable

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

Parameters

T

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

Inheritors

Properties

abstract var collideable: Boolean

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

abstract val costumes: MutableList<T>

A list of all costumes associated with this sprite.

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.

frictionCoefficient

var Positionable.frictionCoefficient: Double

The friction coefficient of the Positionable object. This is used in physics calculations to determine the frictional force acting on the object. The default value is defaultFrictionCoefficient.

abstract override val id: ERROR CLASS: Symbol not found for Uuid

The ID of the sprite.

abstract val isDrawn: Boolean

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

var Positionable.mass: Double

The mass multiplier of the Positionable object. This is used in physics calculations to determine the effective mass of the object. The default value is 1.0.

restitutionCoefficient

var Positionable.restitutionCoefficient: Double

The restitution coefficient of the Positionable object. This is used in physics calculations to determine how bouncy the object is after collisions. The default value is defaultRestitutionCoefficient.

var Positionable.spinFactor: Float

The spin factor of the Positionable object.

abstract var static: Boolean

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

abstract var x: Float

The x-coordinate of the object.

abstract var y: Float

The x-coordinate of the object.

Functions

open fun addCostume(costume: T)

Adds a costume to this sprite.

abstract fun changeTo(index: Int)

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

abstract operator override fun equals(other: Any?): Boolean

abstract override fun hashCode(): Int

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.

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.

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

Sets the costume at the specified index for this sprite.

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.

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.