Auto-Complétion

Environ 383 motsEnviron 1 min

2026-01-19

Aperçu

L’auto-complétion est une fonctionnalité clé de RbxPI. Sans celle-ci, vous seriez contraint de parcourir chaque paquet afin de rechercher les fonctions susceptibles de vous être utiles. Grâce à l’auto-complétion, chaque paquet, fonction et variable est répertorié, ce qui permet un gain de temps considérable.

Avertissement

Seuls les paquets présents dans la bibliothèque standard de RbxPI sont répertoriés dans l’API et peuvent, par conséquent, bénéficier de l’auto-complétion.

Utilisation

Pour bénéficier de l’auto-complétion, il suffit d’importer l’API de RbxPI dans votre code. Cette fonctionnalité est disponible quel que soit le mode d’installation utilisé.

Cette fonctionnalité fonctionne aussi bien côté serveur que côté client.

script.server.luau

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

local API = require(RbxPI.API)

Après avoir importé l’API, il vous suffit de l’appeler afin de bénéficier de l’auto-complétion.

script.server.luau

local versionInfo = API.version

Configuration

Avertissement

Cette API n’est pas représentative de l’API réelle de RbxPI ; elle est fournie uniquement à titre d’exemple.

ReplicatedStorage/RbxPI/API.luau

local API = {}:: {
    --[[
    Ce format indique l’exportation d’une variable

    `version` est le nom de la variable
    `string` indique le type de la valeur

    API.version
    ]]
    version: string,
    --[[
    Exportation d'un paquet

    API.__rhello__
    ]]
    __rhello__: {
        --[[
        Ce format indique l'exportation d'une fonction contenant des arguments 
        mais en ne renvoyant aucune valeur

        `helloworld` : nom de la fonction
        `message: string` : argument en string attendu
        `nil` : valeur retourné

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

        --[[
        Ce format indique l'exportation d'une fonction sans attendre d'argument 
        mais en renvoyant une valeur

        `eggs` : nom de la fonction
        `()` : argument en string attendu, ici aucun
        `string` : valeur retourné

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

Notes

Si vous utilisez des paquets ne faisant pas partie de la bibliothèque standard de RbxPI, vous pouvez étendre votre API en y exposant les fonctions et variables définies par leurs créateurs.

Attention

Si un paquet requiert davantage qu’une simple extension de l’API, notamment via la modification du code, la suppression de fichiers ou toute autre action intrusive, il est fortement déconseillé de procéder à son installation.