Client API
Todo lo de aquí vive en CoreClientAPI y se ejecuta desde un LocalScript de cliente:
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ClientAPI = require(hd.Core.ClientAPI)
Mensajes¶
prompt Shared¶
ClientAPI.prompt(promptType: PromptType, text: string, options: PromptOptions?): PromptHandle
Muestra un aviso o un mensaje al jugador local usando la interfaz propia de HD Admin, desde cualquier LocalScript. Es la misma función que el prompt de la API de comandos, que cubre todos los tipos de mensaje y opciones, solo que sin el argumento player:
ClientAPI.prompt("success", "Quest complete!", {duration = 5})
Información¶
getSetting Shared¶
ClientAPI.getSetting(settingName: string, player: Player?): any
Devuelve el valor de un ajuste del juego, como ClientAPI.getSetting("Prefix"). Pasa el jugador local para aplicar también sus You Settings, y así obtener el valor exacto que él experimenta. En el cliente solo están disponibles los You Settings del jugador local.
getVersion Shared¶
ClientAPI.getVersion(): string
La versión de HD Admin que se está ejecutando, como "v2.0.0".
Panel¶
getAppIcon Client¶
ClientAPI.getAppIcon(): Icon
Devuelve el icono de la barra superior de HD Admin, un Icon de TopbarPlus, para que puedas cambiarle el estilo, moverlo u ocultarlo con toda la API de TopbarPlus.
local icon = ClientAPI.getAppIcon()
icon:align("Right")
openProfile Client¶
ClientAPI.openProfile(userId: number)
Abre la ventana emergente del perfil de un usuario, como al seleccionarlo en la página Moderation.
openPage Client¶
ClientAPI.openPage(pageName: string)
Abre el panel directamente en la página indicada, por ejemplo:
ClientAPI.openPage("Commands")
openPanel Client¶
ClientAPI.openPanel()
Abre el panel de HD Admin para el jugador local, como si hubiera seleccionado el icono de la barra superior.
closePanel Client¶
ClientAPI.closePanel()
Cierra el panel si está abierto.
isPanelOpen Client¶
ClientAPI.isPanelOpen(): boolean