kray/kray.sprites/Sprite2D

Sprite2D

class Sprite2D(raw: Image) : Sprite<Image> , Positionable2D, Sizeable2D

Represents a sprite in the Kray game engine.

Constructors

Sprite2D

constructor(raw: Image)

Types

Companion

object Companion

Properties

area

open val area: Int

The area of the object's bounding box, based on its size parameters.

collideable

open override var collideable: Boolean

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

costumes

open override val costumes: ERROR CLASS: Unresolved name: mutableListOf

An immutable list of all costumes (images) associated with this sprite.

currentCostume

open val currentCostume: Image

The current costume that the sprite is wearing.

currentCostumeIndex

open override var currentCostumeIndex: Int

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

height

open override val height: Int

The height of the object.

isDrawn

open override var isDrawn: Boolean

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

perimeter

open val perimeter: Int

The perimeter of the object's bounding box, based on its size parameters.

static

open override var static: Boolean

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

width

open override val width: Int

The width of the object.

open override var x: Int

The x-coordinate of the object.

open override var y: Int

The y-coordinate of the object.

zIndex

var zIndex: Int

The z-index of the sprite. Higher values are drawn on top of lower values.

Functions

addCostume

open fun addCostume(costume: Image)

Adds a costume to this sprite.

changeTo

open override fun changeTo(index: Int)

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

moveBy

open fun moveBy(deltaX: Int, deltaY: Int)

Moves the object by the specified deltaX and deltaY offsets in place.

moveTo

open fun moveTo(newX: Int, newY: Int)

Moves the object to the specified newX and newY coordinates in place.

nextCostume

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

open override 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: Image)

Removes the specified costume from this sprite.

removeCostumeAt

open fun removeCostumeAt(index: Int)

Removes the costume at the specified index from this sprite.

resize

open override fun resize(newWidth: Int, newHeight: Int): Sprite2D

Resizes the object to the specified newWidth and newHeight in place.

setCostume

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

Sets the costume at the specified index for this sprite.

setCostumes

open fun setCostumes(vararg list: Image)

open fun setCostumes(list: Iterable<Image>)

Sets the costumes for this sprite.

setCurrentCostume

open override fun setCurrentCostume(costume: Image)

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

open override fun switchTo(costume: Image)

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