Skip to content

API Documentation

This part of the documentation is for all of the properties and functions you're able to access inside of light's API. It also teaches you more about Datatypes and ways you could use them efficiently.

Tags

Client

API can be accessed on the client:
require(ReplicatedStorage.light).client

Server

API can be accessed on the server:
require(ReplicatedStorage.light).server

Shared

API can be accessed in a shared context:
require(ReplicatedStorage.light).shared

Synchronous

Function can run without yielding the current thread

Yielding

Function can yield the current thread

Errors

Function can error under specific circumstances.(1)

  1. This tag does not include errors from user mistakes, like trying to write a string into a u8 Datatype, or calling an API with the wrong parameters.

Experimental

This part of the API is considered experimental for now, and may change or be removed at any point.