Auto-Completion

About 342 wordsAbout 1 min

2026-01-24

Overview

Auto-completion is a key feature of RbxPI. Without it, you would be forced to browse through every package to find the functions that might be useful to you. Thanks to auto-completion, every package, function, and variable is indexed, allowing for considerable time savings.

Warning

Only packages present in the RbxPI standard library are indexed in the API and can, therefore, benefit from auto-completion.

Usage

To benefit from auto-completion, simply import the RbxPI API into your code. This feature is available regardless of the installation method used.

This feature works equally well on both the server and client sides.

script.server.luau

local ReplicatedStorage = game:GetService("ReplicatedStorage")
local RbxPI = ReplicatedStorage:WaitForChild("RbxPI")

local API = require(RbxPI.API)

After importing the API, simply call it to benefit from auto-completion.

script.server.luau

local versionInfo = API.version

Configuration

Warning

This API is not representative of the actual RbxPI API; it is provided for example purposes only.

ReplicatedStorage/RbxPI/API.luau

local API = {}:: {
    --[[
    This format indicates the export of a variable:

    `version` is the variable name
    `string` indicates the value type

    API.version
    ]]
    version: string,
    --[[
    Package Export

    API.__rhello__
    ]]
    __rhello__: {
        --[[
        This format indicates the export of a function containing arguments but returning no value:

        `helloworld`: name of the function
        `message: string`: expected string argument
        `nil`: returned value

        API.__rhello__.helloworld("Hello World!")
        ]]
        helloworld: (message: string) -> nil,

        --[[
        This format indicates the export of a function that does not expect any arguments but returns a value

        `eggs` : name of the function
        `()` : expected arguments, none in this case
        `string` : returned value

        local contenu = API.__rhello__.eggs()
        ]]
        eggs: () -> { string },
    }
}

Notes

If you use packages that are not part of the RbxPI standard library, you can extend your API by exposing the functions and variables defined by their creators.

Caution

If a package requires more than a simple API extension, such as code modification, file deletion, or any other intrusive action, it is strongly discouraged to proceed with its installation.