19min

API Reference

Welcome to the API Reference. Here, you can find all the custom functions that Krnl has. You can find examples and notes for each of the functions. Please read below to further understand the reference.

Krnl currently has 151 custom functions! (excluding aliases)

Unified Naming Convention

Document image

Krnl follows the Unified Naming Convention, which means that Krnl uses vanilla function names that can be found on other exploits. UNC makes it easier for script developers since you won't have to worry about unique function names such as is_synapse_function.

Documentation Format

Document image
  1. The function's full name
  2. What the function returns (table, string, number, bool, etc)
    1. <variant> means that the return values could be any data type.

    2. <void> means that the function does not have any return values.
    3. <A, B> means that the return values can be more than 1 data type (ex. <LocalScript, ModuleScript>).
  3. The actual function name
  4. The data type that the parameter accepts (table, string, number, bool, etc)
    1. <variant> means that the parameter could be any data type.
    2. <void> means that the function does not have any parameters.
    3. <A, B> means that the parameter can be more than 1 data type (ex. <LocalScript, ModuleScript>).

    4. ... means there are variable amounts of parameters.
  5. If you see a ? after the data type, it means that that specific parameter is optional.
  6. The name of the parameter
    1. If you see something like IncludeTables = false, it means that if no parameter is provided, it will default to that value. In this case, if we do getgc() with no parameters, it will default to false.
  7. The function's description
    1. Some functions may have an example showing how the function is used below the description.

Understanding Parameters

<T, X> refers to functions that can return more than 1 type for that specified argument/return value. (ex. <LocalScript, ModuleScript>) ? refers to an optional parameter. (ex. <bool?>) <void> refers to functions with no parameters/return values. <variant> refers to parameters/return values that could be any type. ... refers to variable amounts of parameters/return values. a = b refers to the function's default value if no parameter is specified.

Note

This reference may have incorrect information as some functions may have not been tested properly.

Visual Studio Code Extensions

Sources

Last Updated: July 21, 2022



Updated 21 Jul 2022
Did this page help you?
Yes
No