Skip to content
The Kitnomicon

KitStd

The Welcome To Hell Kit Standard Library is contains many utilities, including types like Attribute, In addition to the Welcome To Hell API which is bundled as part of the kit, the game also provides this sibling package that contains a set of utilities to streamline common patterns and operations used in Mechanics.

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local std = require(ReplicatedStorage:WaitForChild("KitStd"))

Properties

Section titled “Properties”

activation

Section titled “activation”
KitStd.activation: KitStdActivation

Activation utilities.

animation

Section titled “animation”
KitStd.animation: unknown

Animation utilities including tweens.

assets

Section titled “assets”
KitStd.assets: unknown

Image and sound assets used by Welcome To Hell.

audio

Section titled “audio”
KitStd.audio: unknown

Audio utilities.

bindings

Section titled “bindings”
KitStd.bindings: KitStdBindings

Bindings to Welcome To Hell’s controllers.

character

Section titled “character”
KitStd.character: unknown

Character utilities.

collections

Section titled “collections”
KitStd.collections: unknown

Math utilities.

collections

Section titled “collections”
KitStd.collections: unknown

Collection utilities and implementations.

color

Section titled “color”
KitStd.color: unknown

Color utilities.

logger

Section titled “logger”
KitStd.logger: unknown

Logger implementation.

physics

Section titled “physics”
KitStd.physics: unknown

Physic utilities.

prelude

Section titled “prelude”
KitStd.prelude: KitStdPrelude

Reference to the prelude, the list of things that most KitScripts will use, and is kept as small as possible.

touch

Section titled “touch”
KitStd.touch: unknown

Touch utilities.

version

Section titled “version”
KitStd.version: string

The current version of the Kit Standard Library.

Functions

Section titled “Functions”

never

Section titled “never”
function KitStd.never(...: never): never

Never returns. This is most useful when preventing bugs relating to not properly matching every value, ie:

type Color = "red" | "blue" | "green"
local function setColor(color: Color)
  if color == "red" then
    -- red
  elseif color == "blue" then
    -- blue
  else
    -- TYPE ERROR! You forgot to match "green".
    std.never(color)
  end
end

Parameters

Section titled “Parameters”
… : never
Section titled “… : never”

Any value that should never exist.

Returns

Section titled “Returns”
never
Section titled “never”

Will error if a value supposedly never meant to exist, well, exists.`

roundColor

Section titled “roundColor”
function KitStd.roundColor(color: Color3): Color3

Parameters

Section titled “Parameters”
color : Color3
Section titled “color : Color3”

Returns

Section titled “Returns”
Color3
Section titled “Color3”

`