kray/kray.sprites/Sprite2D

Sprite2D

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

Represents a sprite in the Kray game engine.

Constructors

constructor(raw: Texture2D)

Types

object Companion

Properties

open val area: Int

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

var Positionable2D.ax: Double

The x-component of the 2D acceleration of the Positionable2D object.

var Positionable2D.ay: Double

The y-component of the 2D acceleration of the Positionable2D object.

open override var collideable: Boolean

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

val Sprite2D.collisions: Set<Sprite2D>

A set of all 2D sprites that are currently colliding with this sprite. Uses spatial hashing for O(n) average case complexity.

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

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

open val currentCostume: Texture2D

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.

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.

open override val height: Int

The height of the object.

open override var hitbox: Hitbox2D

The hitbox of the object.

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

The ID of the sprite.

val Sprite2D.inBounds: Set<Sprite2D>

A set of all 2D sprites that are currently inside its boundaries.

val Sprite2D.isClicked: Boolean

Checks if the sprite is currently being clicked by any mouse button.

val Sprite2D.isDown: Boolean

Checks if any mouse button is currently being pressed on the sprite.

open override var isDrawn: Boolean

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

val Sprite2D.isLeftDown: Boolean

Checks if the sprite is currently being clicked by the mouse.

val Sprite2D.isMiddleDown: Boolean

Checks if the sprite is currently being middle-clicked by the mouse.

val Sprite2D.isMouseOver: Boolean

Checks if the sprite is currently being hovered over by the mouse.

val Sprite2D.isRightDown: Boolean

Checks if the sprite is currently being right-clicked by the mouse.

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.

open val perimeter: Int

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

open val position: ERROR CLASS: Symbol not found for Pair<kotlin/Float, kotlin/Float>

The position of the object.

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.

open override var rotation: Float

The rotation angle of the object in degrees.

open override var scale: Float

The scale of the object.

var Positionable.spinFactor: Float

The spin factor of the Positionable object.

open override var static: Boolean

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

var Sprite2D.targetRotation: Float

The target rotation steps to move toward then on the ground.

var Positionable2D.vx: Double

The x-component of the 2D velocity of the Positionable2D object.

var Positionable2D.vy: Double

The y-component of the 2D velocity of the Positionable2D object

open override val width: Int

The width of the object.

open override var x: Float

The x-coordinate of the object.

open override var y: Float

The x-coordinate of the object.

var zIndex: Int

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

Functions

open fun addCostume(costume: Texture2D)

Adds a costume to this sprite.

alignHorizontalLeft

fun Positionable2D.alignHorizontalLeft(margin: Float = 0.0f)

Aligns the object to the left side of the screen.

fun Positionable2D.alignHorizontalLeft(target: Positionable2D, margin: Float = 0.0f)

Aligns the object to the left side of the target object.

alignHorizontalRight

fun Positionable2D.alignHorizontalRight(margin: Float = 0.0f)

Aligns the object to the top side of the screen.

fun Positionable2D.alignHorizontalRight(target: Positionable2D, margin: Float = 0.0f)

Aligns the object to the right side of the target object.

alignVerticalBottom

fun Positionable2D.alignVerticalBottom(margin: Float = 0.0f)

Aligns the object to the bottom side of the screen.

fun Positionable2D.alignVerticalBottom(target: Positionable2D, margin: Float = 0.0f)

Aligns the object to the bottom side of the target object.

alignVerticalTop

fun Positionable2D.alignVerticalTop(margin: Float = 0.0f)

Aligns the object to the top side of the screen.

fun Positionable2D.alignVerticalTop(target: Positionable2D, margin: Float = 0.0f)

Aligns the object to the top side of the target object.

open override fun changeTo(index: Int)

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

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

open override fun hashCode(): Int

open override fun isAbove(y: Float): Boolean

Returns whether the sprite is above the given Y boundary.

open override fun isBelow(y: Float): Boolean

Returns whether the sprite is below the given Y boundary.

open override fun isLeft(x: Float): Boolean

Returns whether the sprite is left of the given X boundary.

open override fun isRight(x: Float): Boolean

Returns whether the sprite is right of the given X boundary.

fun Sprite2D.lerpSpin(degrees: Float)

Adds spin to a sprite that will be applied gradually over multiple frames.

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

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

fun Sprite2D.moveDownKey(key: Key, speed: Double = 1.0)

Moves the sprite down when the given key is pressed.

fun Sprite2D.moveLeftKey(key: Key, speed: Double = 1.0)

Moves the sprite left when the given key is pressed.

fun Sprite2D.moveRightKey(key: Key, speed: Double = 1.0)

Moves the sprite left when the given key is pressed.

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

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

fun Sprite2D.moveUpKey(key: Key, speed: Double = 1.0)

Moves the sprite up when the given key is pressed.

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.

suspend fun Sprite2D.onClick(action: suspend Kray.() -> Unit)

Performs the given action if the sprite is being clicked by any mouse button.

suspend fun Sprite2D.onDown(action: suspend Kray.() -> Unit)

Performs the given action if the sprite is being clicked by any mouse button.

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.

open fun removeCostume(costume: Texture2D)

Removes the specified costume from this sprite.

removeCostumeAt

open fun removeCostumeAt(index: Int)

Removes the costume at the specified index from this sprite.

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

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

setAcceleration

fun Positionable2D.setAcceleration(ax: Double, ay: Double)

Sets both the x and y components of the 2D acceleration of the Positionable2D object.

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

Sets the costume at the specified index for this sprite.

open fun setCostumes(vararg list: Texture2D)

open fun setCostumes(list: Iterable<Texture2D>)

Sets the costumes for this sprite.

setCurrentCostume

open override fun setCurrentCostume(costume: Texture2D)

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.

fun Positionable2D.setVelocity(vx: Double, vy: Double)

Sets both the x and y components of the 2D velocity of the Positionable2D object.

open override fun spin(degrees: Float)

Rotates the object by the specified degrees in place.

open override fun switchTo(costume: Texture2D)

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