Client API
Всё, что описано здесь, находится в CoreClientAPI и запускается из клиентского LocalScript:
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ClientAPI = require(hd.Core.ClientAPI)
Запросы¶
prompt Shared¶
ClientAPI.prompt(promptType: PromptType, text: string, options: PromptOptions?): PromptHandle
Показывает локальному игроку уведомление или сообщение через собственный интерфейс HD Admin, из любого LocalScript. Это та же функция, что и prompt в Command API, где описаны все типы запросов и опции, только без аргумента player:
ClientAPI.prompt("success", "Quest complete!", {duration = 5})
Информация¶
getSetting Shared¶
ClientAPI.getSetting(settingName: string, player: Player?): any
Возвращает значение настройки игры, например ClientAPI.getSetting("Prefix"). Передай локального игрока, чтобы дополнительно применились его личные настройки (You Settings), и ты получишь именно то значение, которое видит он. На клиенте доступны только личные настройки (You Settings) локального игрока.
getVersion Shared¶
ClientAPI.getVersion(): string
Версия HD Admin, которая сейчас запущена, например "v2.0.0".
Панель¶
getAppIcon Client¶
ClientAPI.getAppIcon(): Icon
Возвращает значок HD Admin на верхней панели, то есть Icon из TopbarPlus. Через полный API TopbarPlus его можно изменить внешне, переместить или скрыть.
local icon = ClientAPI.getAppIcon()
icon:align("Right")
openProfile Client¶
ClientAPI.openProfile(userId: number)
Открывает всплывающий профиль пользователя, как при выборе игрока на странице Moderation.
openPage Client¶
ClientAPI.openPage(pageName: string)
Открывает панель сразу на нужной странице, например:
ClientAPI.openPage("Commands")
openPanel Client¶
ClientAPI.openPanel()
Открывает панель HD Admin для локального игрока, как если бы он нажал на значок на верхней панели.
closePanel Client¶
ClientAPI.closePanel()
Закрывает панель, если она открыта.
isPanelOpen Client¶
ClientAPI.isPanelOpen(): boolean