kray/kray.sprites/Sprite3D

Sprite3D

class Sprite3D(raw: Model) : Sprite<Model> , Positionable3D, Sizeable3D

Represents a sprite in the Kray game engine.

Constructors

constructor(raw: Model)

Types

object Companion

Properties

var Positionable3D.ax: Double

The x-component of the 3D acceleration of the Positionable3D object.

var Positionable3D.ay: Double

The y-component of the 3D acceleration of the Positionable3D object.

var Positionable3D.az: Double

The z-component of the 3D acceleration of the Positionable3D object.

open override var collideable: Boolean

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

val Sprite3D.collisions: Set<Sprite3D>

A set of all 3D 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 (models) associated with this sprite.

open val currentCostume: Model

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.

open override val depth: Int

The depth of the object.

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: Hitbox3D

The hitbox of the object used for collision detection.

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

The ID of the sprite.

val Sprite3D.inBounds: Set<Sprite3D>

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

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

open val position: ERROR CLASS: Symbol not found for Triple<kotlin/Float, 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.

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 Sprite3D.storedRotation: ERROR CLASS: Symbol not found for Triple<kotlin/Float, kotlin/Float, kotlin/Float>

The stored rotation of the 3D sprite as Euler angles (pitch, yaw, roll) in radians. This is the source of truth for rotation, separate from the transform matrix.

open val surfaceArea: Int

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

var Sprite3D.targetRotation: ERROR CLASS: Symbol not found for Triple<kotlin/Float, kotlin/Float, kotlin/Float>

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

open override var transform: Matrix4

The transformation matrix of the positionable.

open val volume: Int

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

var Positionable3D.vx: Double

The x-component of the 3D velocity of the Positionable3D object.

var Positionable3D.vy: Double

The y-component of the 3D velocity of the Positionable3D object.

var Positionable3D.vz: Double

The z-component of the 3D velocity of the Positionable3D 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.

open override var z: Float

The z-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: Model)

Adds a costume to this sprite.

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 isLeftX(x: Float): Boolean

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

open override fun isLeftZ(z: Float): Boolean

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

open override fun isRightX(x: Float): Boolean

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

open override fun isRightZ(z: Float): Boolean

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

fun Sprite3D.lerpRotation(pitch: Float, yaw: Float, roll: Float)

Adds rotation to a 3D sprite that will be applied gradually over multiple frames.

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

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

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

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

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.

open fun removeCostume(costume: Model)

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 rotate(pitch: Float, yaw: Float, roll: Float)

Rotates the transform matrix.

open fun scale(scale: Float)

open fun scale(sx: Float, sy: Float, sz: Float)

Scales the transform matrix.

setAcceleration

fun Positionable3D.setAcceleration(ax: Double, ay: Double, az: Double)

Sets the x, y, and z components of the 3D acceleration of the Positionable3D object.

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

Sets the costume at the specified index for this sprite.

open fun setCostumes(vararg list: Model)

open fun setCostumes(list: Iterable<Model>)

Sets the costumes for this sprite.

setCurrentCostume

open override fun setCurrentCostume(costume: Model)

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 Positionable3D.setVelocity(vx: Double, vy: Double, vz: Double)

Sets the x, y, and z components of the 3D velocity of the Positionable3D object.

open override fun switchTo(costume: Model)

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

open fun translate(x: Float, y: Float, z: Float)

Translates the transform matrix.