xhookLua
Game

util

Small numeric helpers.

Functions

util.clamp

util.clamp(v, lo, hi) -> number
NameType
vnumber
lonumber
hinumber

Clamps v into [lo, hi].

util.lerp

util.lerp(a, b, t) -> number
NameTypeDescription
anumber
bnumber
tnumber0 gives a, 1 gives b.

Linear interpolation; t is not clamped.

Returns a + (b - a) * t

util.round

util.round(v) -> integer
NameType
vnumber

Rounds halves up: -2.5 gives -2.

Returns floor(v + 0.5)

util.sign

util.sign(v) -> integer
NameType
vnumber

Sign of a number.

Returns 1, -1 or 0

util.map

util.map(v, a, b, c, d) -> number
NameTypeDescription
vnumber
anumberSource range start.
bnumberSource range end.
cnumberTarget range start.
dnumberTarget range end.

Remaps v from [a, b] to [c, d], unclamped.

Returns c when a == b.

util.normalize_yaw

util.normalize_yaw(yaw) -> number
NameTypeDescription
yawnumberDegrees.

Wraps an angle into -180 to 180 degrees.

util.approach

util.approach(cur, target, delta) -> number
NameTypeDescription
curnumber
targetnumber
deltanumberMax step; sign ignored.

Steps cur towards target by at most delta.

Returns no overshoot

util.spring_damper

util.spring_damper([stiffness] [, damping]) -> spring
NameTypeDescription
stiffnessoptionalnumberDefault 120.
dampingoptionalnumberOmit for critical (no overshoot).

Spring that eases the view toward a target, for human-like aim.

Damping under 2 * sqrt(stiffness) overshoots a little, then settles.

spring:step

spring:step(delta, dt) -> Angle
NameTypeDescription
deltaAngleTarget minus current view.
dtnumberSeconds.

Turn to apply this step.

Yaw in delta wraps to -180 to 180.

spring:reset

spring:reset()

Drops the carried speed; call it when the target changes.

spring:set

spring:set(stiffness [, damping])
NameTypeDescription
stiffnessnumber
dampingoptionalnumberOmit for critical.

Changes the spring.

spring:velocity

spring:velocity() -> Angle

Current turn speed in degrees per second.

util.hash

util.hash(s) -> integer
NameType
sstring

32-bit FNV-1a of a string, 0 to 4294967295.

Fast, not for passwords.

util ยท Lua API ยท xhook