Aller au contenu

API du client

Tout ce qui suit se trouve dans CoreClientAPI et s'exécute depuis un LocalScript client :

local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ClientAPI = require(hd.Core.ClientAPI)

Invites

prompt Shared

ClientAPI.prompt(promptType: PromptType, text: string, options: PromptOptions?): PromptHandle

Affiche une notification ou un message au joueur local avec l'interface propre à HD Admin, depuis n'importe quel LocalScript. C'est la même fonction que le prompt de la Command API, qui détaille tous les types d'invite et toutes les options, simplement sans l'argument player :

ClientAPI.prompt("success", "Quest complete!", {duration = 5})

Infos

getSetting Shared

ClientAPI.getSetting(settingName: string, player: Player?): any

Renvoie la valeur d'un paramètre du jeu, par exemple ClientAPI.getSetting("Prefix"). Passe le joueur local pour appliquer aussi ses You Settings, et obtenir ainsi la valeur exacte qu'il vit en jeu. Seuls les You Settings du joueur local sont disponibles côté client.


getVersion Shared

ClientAPI.getVersion(): string

La version de HD Admin en cours d'exécution, par exemple "v2.0.0".


Panneau

getAppIcon Client

ClientAPI.getAppIcon(): Icon

Renvoie l'icône de HD Admin dans la barre du haut, un Icon TopbarPlus, pour que tu puisses changer son style, la déplacer ou la masquer avec toute l'API TopbarPlus.

local icon = ClientAPI.getAppIcon()
icon:align("Right")

openProfile Client

ClientAPI.openProfile(userId: number)

Ouvre la fenêtre de profil d'un utilisateur, comme quand on le sélectionne dans la page Modération.


openPage Client

ClientAPI.openPage(pageName: string)

Ouvre le panneau directement sur la page donnée, par exemple :

ClientAPI.openPage("Commands")


openPanel Client

ClientAPI.openPanel()

Ouvre le panneau HD Admin pour le joueur local, comme s'il avait sélectionné l'icône de la barre du haut.


closePanel Client

ClientAPI.closePanel()

Ferme le panneau s'il est ouvert.


isPanelOpen Client

ClientAPI.isPanelOpen(): boolean