Shared

clamp

fjsf.clamp(inputValue, minimum, maximum)

Restricts a number to a specified range.

Parameters

  • inputValue (number) β€” The value to clamp

  • minimum (number) β€” The lower boundary

  • maximum (number) β€” The upper boundary

Returns

  • (number) β€” The value constrained to the range

Example

local health = fjsf.clamp(playerHealth, 0, 200)

round

fjsf.round(inputValue, decimalPlaces)

Rounds a number to a specified number of decimal places.

Parameters

  • inputValue (number) β€” The number to round

  • decimalPlaces (number) β€” The amount of decimal precision

Returns

  • (number) β€” The rounded number

Example


lerp

Performs linear interpolation between two numbers.

Useful for smooth transitions such as fades, movement, or UI animations.

Parameters

  • startValue (number) β€” The starting value

  • endValue (number) β€” The target value

  • progress (number) β€” Interpolation factor between 0 and 1

Returns

  • (number) β€” The interpolated value

Example


invLerp

Converts a value into a normalized range between 0 and 1.

Often used to calculate progress or percentages from raw values.

Parameters

  • rangeStart (number) β€” The minimum range value

  • rangeEnd (number) β€” The maximum range value

  • currentValue (number) β€” The value to normalize

Returns

  • (number) β€” A normalized value between 0 and 1

Example


snap

Snaps a number to the nearest step value.

Parameters

  • inputValue (number) β€” The value to snap

  • stepSize (number) β€” The step interval

Returns

  • (number) β€” The snapped value

Example


oscillate

Generates a smooth oscillating value using a sine wave.

Useful for UI effects and subtle animations.

Parameters

  • timeValue (number) β€” The time or frame value

  • amplitude (number) β€” The maximum output value

  • frequency (number) β€” The speed of oscillation

Returns

  • (number) β€” The oscillated value

Example


mapRange

Maps a number from one range into another range.

Parameters

  • inputValue (number) β€” The value to remap

  • sourceMin (number) β€” The minimum of the source range

  • sourceMax (number) β€” The maximum of the source range

  • targetMin (number) β€” The minimum of the target range

  • targetMax (number) β€” The maximum of the target range

Returns

  • (number) β€” The remapped value

Example

hexToRgb

Converts a HEX color string into RGB values.

Parameters

  • hexColor (string) β€” Color in #RRGGBB or RRGGBB format

Returns

  • (number) Red

  • (number) Green

  • (number) Blue

Example


rgbToHex

Converts RGB values into a HEX color string.

Parameters

  • red (number)

  • green (number)

  • blue (number)

Returns

  • (string) HEX color string

Example


hexToRgba

Converts a HEX color into RGBA values.

Parameters

  • hexColor (string)

  • alpha (number, optional)

Returns

  • (number) Red

  • (number) Green

  • (number) Blue

  • (number) Alpha

Example

Last updated