kray/kray.physics

Package-level declarations

Types

interface Hitbox

Represents a hitbox.

class Hitbox2D(val minX: Float, val minY: Float, val maxX: Float, val maxY: Float, val inside: (ERROR CLASS: Symbol not found for Pair<kotlin/Float, kotlin/Float>) -> Boolean) : Hitbox

A 2D hitbox for collision detection.

Hitbox3D

class Hitbox3D(val minX: Float, val minY: Float, val minZ: Float, val maxX: Float, val maxY: Float, val maxZ: Float, val inside: (ERROR CLASS: Symbol not found for Triple<kotlin/Float, kotlin/Float, kotlin/Float>) -> Boolean) : Hitbox

A 3D hitbox for collision detection.

Properties

var Positionable2D.ax: Double

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

var Positionable3D.ax: Double

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

var Positionable2D.ay: Double

The y-component of the 2D acceleration of the Positionable2D 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.

cellSize

var cellSize: Int

The size of each cell in the spatial grid used for collision detection.

collisionPrecision

var collisionPrecision: Int

The precision used for collision detection sampling. This number is the number of samples taken along each axis within a spatial grid cell.

collisions

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.

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.

defaultFrictionCoefficient

var defaultFrictionCoefficient: Double

The default friction coefficient used in physics calculations. The default value is 0.5.

defaultRestitutionCoefficient

var defaultRestitutionCoefficient: Double

The default restitution coefficient used in physics calculations.

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.

gravity

var gravity: Double

The gravitational acceleration constant used in physics calculations. The default value is 9.81 m/s².

groundY

var groundY: Float

The y-coordinate representing the ground level in the physics simulation. Objects should not fall below this y-coordinate.

mass

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.

maxX

var maxX: Float

The maximum x-coordinate boundary in the physics simulation.

maxZ

var maxZ: Float

The maximum z-coordinate boundary in the physics simulation.

minX

var minX: Float

The minimum x-coordinate boundary in the physics simulation.

minZ

var minZ: Float

The minimum z-coordinate boundary in the physics simulation.

NORMAL_THRESHOLD

const val NORMAL_THRESHOLD: Double = 0.05

The normal threshold for vector values.

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.

spinDecayFactor

var spinDecayFactor: Float

The spin decay factor per frame. Higher values = slower decay.

spinFactor

var Positionable.spinFactor: Float

The spin factor of the Positionable object.

storedRotation

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.

targetRotation

var Sprite2D.targetRotation: Float

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.

terminalVelocity

var terminalVelocity: Float

The terminal velocity of all objects in the engine.

var Positionable2D.vx: Double

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

var Positionable3D.vx: Double

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

var Positionable2D.vy: Double

The y-component of the 2D velocity of the Positionable2D 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.

Functions

engineTick

fun engineTick(): Set<Positionable>

Advances the physics engine by one tick, updating the positions and velocities of all non-static objects based on the applied forces such as gravity and friction.

lerpRotation

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

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

lerpSpin

fun Sprite2D.lerpSpin(degrees: Float)

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

setAcceleration

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

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

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

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

setVelocity

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

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

fun Positionable3D.setVelocity(vx: Double, vy: Double, vz: Double)

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