Command API
Todo lo que un comando puede referenciar de forma segura está en CommandAPI:
local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)
Carga¶
loadCommands Server¶
CommandAPI.loadCommands(details): Commands
Esto es lo que usan los módulos de paquetes en Config > Commands para cargar, etiquetar y modificar sus conjuntos de comandos. Abre cualquiera de los paquetes de ahí para verlo en acción.
Mensajes¶
prompt Shared¶
-- In a server command module
CommandAPI.prompt(promptType: PromptType, player: Player, text: string, options: PromptOptions?): PromptHandle
-- In a client command module
CommandAPI.prompt(promptType: PromptType, text: string, options: PromptOptions?): PromptHandle
Muestra un aviso, un mensaje o una tarjeta. Para mensajes de acción con botones, consulta bindPrompt.
| Tipo de mensaje | Qué muestra |
|---|---|
"info" "success" "warn" "error" |
Un aviso en la barra lateral con un efecto de sonido |
"message" |
Un mensaje en el centro de la pantalla, usado por ejemplo en ;message |
"hint" |
Una barra pequeña en la parte superior de la pantalla, usada por ejemplo en ;hint |
"privateMessage" |
Un aviso fijo en la barra lateral que abre el mensaje completo al hacer clic |
"alert" |
Un aviso fijo en la barra lateral que repite un sonido hasta que se silencia y abre el mensaje completo al hacer clic |
"action" |
Un aviso en la barra lateral con botones y controles. Créalos con task:bindPrompt |
CommandAPI.prompt("success", task.caller, "Quest complete!", {duration = 5})
Devuelve una conexión que puedes desconectar con connection:Disconnect() para terminar el mensaje. Por ejemplo, puedes agregarla al janitor de una tarea para que termine en cuanto termine el comando:
task.janitor:add(CommandAPI.prompt("hint", task.target, "You're frozen until an admin releases you", {duration = 0})) -- 0 means "infinite"
Opciones
Todas son opcionales y funcionan en todos los tipos de mensaje, salvo que la fila indique otra cosa:
| Opción | Tipo | Qué hace |
|---|---|---|
title |
string | El encabezado sobre el texto. privateMessage y alert definen el suyo |
duration |
number | Segundos antes de que el mensaje se cierre solo. Si lo omites, se calcula una duración según la longitud del texto. 0 lo mantiene en pantalla hasta que se cierre o se desconecte |
subtext |
string | Una línea más pequeña debajo del texto |
icon |
string | Una imagen rbxassetid:// que reemplaza el ícono del aviso |
color |
Color3 | Cambia el color del texto de un hint |
dismissable |
boolean | false oculta el botón de cerrar, así que solo duration o el handle pueden quitarlo |
openPage |
string | Al hacer clic en el aviso se abre el panel en esta página, como "Commands", "Roles", "Settings" o "About" |
openProfile |
boolean | Al hacer clic en el aviso se abre el perfil del propio jugador |
openImage |
table | {image = "rbxassetid://...", title = "Map", ratio = 16/9}. Al hacer clic en el aviso se abre la imagen en el centro de la pantalla |
linkButtons |
table | Botones pequeños en la parte inferior del aviso. {label = "Roles", page = "Roles"} abre una página y {label = "Profile", profile = true} abre su perfil. Agrega style = "Neutral" para un botón atenuado y hideAfterPress = true para cerrar el aviso al presionarlo. Desde un LocalScript mediante la Client API, {label = "Shop", onActivate = function() ... end, icon = "rbxassetid://..."} ejecuta tu propia función en su lugar |
roleBadges |
table | Insignias de rol debajo del título, {{name = "Admin", color = Color3.fromRGB(255, 170, 0)}} |
countdown |
number | Cuenta regresiva en vivo desde esta cantidad de segundos, en cada lugar donde aparezca %TIME% en el texto |
fromUserId |
number | Muestra el avatar, el nombre y el rol más alto de ese usuario como remitente de un message, privateMessage o alert |
userText |
boolean | Muestra el texto exactamente como se escribió, sin etiquetas de texto enriquecido, etc. |
CommandAPI.prompt("info", task.caller, "You've unlocked the VIP role", {
title = "New role",
openPage = "Roles",
roleBadges = {{name = "VIP", color = Color3.fromRGB(255, 170, 0)}},
})
Para mensajes de acción con botones, consulta bindPrompt.
Personaje¶
getHumanoid Shared¶
CommandAPI.getHumanoid(player: Player?): Humanoid?
El Humanoid del jugador, o nil si su personaje no está presente.
getHRP Shared¶
CommandAPI.getHRP(player: Player?): BasePart?
El HumanoidRootPart del jugador, o nil.
getHead Shared¶
CommandAPI.getHead(player: Player?): (BasePart?, Model?)
La Head del jugador y su personaje, o nil.
getNeck Shared¶
CommandAPI.getNeck(player: Player?): Motor6D?
La articulación del cuello del jugador, o nil. Funciona con rigs R6 y R15.
getTorso Shared¶
CommandAPI.getTorso(player: Player?): Instance?
El torso del jugador, o nil. Funciona con rigs R6 y R15.
loadCharacter Server¶
CommandAPI.loadCharacter(player: Player?)
Reaparece el personaje del jugador. Usa siempre esto en lugar de player:LoadCharacter() para que las tareas de HD Admin sepan que la reaparición fue intencional.
Jugadores¶
getUserInfoAsync Shared¶
CommandAPI.getUserInfoAsync(userId: number | string): (boolean, UserInfo | string)
Devuelve true y el UserInfo de cualquier usuario, incluso si está desconectado, o false y un motivo. Los resultados se guardan en caché, así que las llamadas repetidas no cuestan nada.
getNameFromUserIdAsync Shared¶
CommandAPI.getNameFromUserIdAsync(userId: number | string): (boolean, string)
Devuelve true y el nombre del usuario, o false y un motivo. Funciona con usuarios desconectados.
teleportAsync Server¶
CommandAPI.teleportAsync(player: Player?, cframe: CFrame): (boolean, string)
Mueve el personaje del jugador al CFrame indicado, haciendo que se levante primero del asiento para que no arrastre consigo el asiento.
getAllowedTargets Server¶
CommandAPI.getAllowedTargets(task: Task, options: {players: {Player}?}?): ({Player}, {Player})
Los jugadores sobre los que puede actuar un comando, que por defecto son todos los del servidor menos quienes tengan activada la opción Block commands en sus You Settings.
unequipTools Server¶
CommandAPI.unequipTools(player: Player?): (boolean, string)
Devuelve la herramienta equipada del jugador a su mochila.
Tareas¶
getTasks Shared¶
CommandAPI.getTasks(commandKey: string?, targetUserId: number?): {Task}
Devuelve las tareas en curso, con filtro opcional por comando y objetivo. Son los mismos objetos de tarea que describe la Task API.
getTasksByCallerId Shared¶
CommandAPI.getTasksByCallerId(callerUserId: number): {Task}
Todas las tareas en curso iniciadas por el usuario indicado.
Chat¶
systemMessage Shared¶
-- In a server command module
CommandAPI.systemMessage(player: Player, text: string)
-- In a client command module
CommandAPI.systemMessage(text: string)
Envía un mensaje con estilo de sistema al chat del jugador.
checkTextLimit Server¶
CommandAPI.checkTextLimit(task: Task, textKind: "Message" | "SurfaceText" | "ChatText" | "Reason"): (boolean, number?)
HD Admin limita el envío de funciones relacionadas con mensajes debido a las políticas de seguridad por edad de Roblox, y esto te permite ver ese tiempo de espera.
Devuelve true cuando se puede mostrar el texto; en caso contrario, false junto con el tiempo de espera restante.
args = {"Player", "Leaderstat", {arg = "String", textSurface = "None"}},
run = function(task)
local stat = task:getArg("Leaderstat")
local text = task:getArg("String")
if stat:IsA("StringValue") then
if not CommandAPI.checkTextLimit(task, "SurfaceText") then
return
end
end
stat.Value = text
end,
| Tipo | Compartido por |
|---|---|
"Message" |
Mensajes, hints, avisos, alertas, mensajes privados y encuestas |
"SurfaceText" |
Nombres, títulos, nombres de equipo y estadísticas |
"ChatText" |
Etiquetas de chat y nombres de chat |
"Reason" |
Motivos de expulsión y de veto |
forceBubbleChat Shared¶
CommandAPI.forceBubbleChat(target: Player | Model, text: string)
Muestra un globo de chat sobre el personaje del jugador, o sobre cualquier modelo o parte que pases en su lugar.
Atuendos¶
getDescription Server¶
CommandAPI.getDescription(humanoid: Humanoid): HumanoidDescription
El HumanoidDescription actual del humanoid.
applyDescription Server¶
CommandAPI.applyDescription(humanoid: Humanoid?, description: HumanoidDescription?, properties: {[string]: any}?): HumanoidDescription?
Aplica el HumanoidDescription de forma segura, reintentando cuando Roblox rechaza el primer intento. Pasa properties para ajustar campos encima de la descripción base.
outfitBuff Server¶
CommandAPI.outfitBuff(target: Player, properties: {[string]: any})
Aplica propiedades de HumanoidDescription como un efecto que se deshace solo cuando termina la tarea, así que comandos como ;wormify se limpian por sí solos.
setFakeBodyParts Server¶
CommandAPI.setFakeBodyParts(character: Model, info: {[string]: any}): (() -> ())?
Cambia partes del cuerpo por reemplazos creados por el comando y devuelve una función que restaura las originales.
clearFakeBodyParts Server¶
CommandAPI.clearFakeBodyParts(character: Model)
Vuelve a quitar esos reemplazos.
runBundleId Server¶
CommandAPI.runBundleId(task: Task, bundleId: number, properties: {[string]: any}?)
Viste al objetivo de la tarea con un paquete del catálogo y le restaura su propio atuendo cuando la tarea termina.
Recursos¶
registerSound Shared¶
CommandAPI.registerSound(sound: Sound)
Es obligatorio para cualquier Sound que cree tu comando, de modo que se le apliquen los ajustes de volumen y tono del juego.
setAnchored Shared¶
CommandAPI.setAnchored(instance: Instance, anchored: boolean)
Ancla o desancla todas las partes dentro de la instancia.
setTransparency Shared¶
CommandAPI.setTransparency(instance: Instance, transparency: number)
Desvanece todas las partes dentro de la instancia.
promptPurchaseAsync Server¶
CommandAPI.promptPurchaseAsync(assetId: number, player: Player?, infoType: Enum.InfoType?)
Muestra al jugador el mensaje de compra del recurso, usando el flujo de compra que corresponda a su tipo.
ownsAssetAsync Server¶
CommandAPI.ownsAssetAsync(assetId: number, player: Player?): boolean
Indica si el jugador es dueño del recurso.
isTypeAsync Server¶
CommandAPI.isTypeAsync(assetId: number, assetType: Enum.AssetType | Enum.BundleType): (boolean, string?)
Verifica que el recurso sea del tipo indicado. Devuelve true, o false y el motivo.
loadAssetCommand Server¶
CommandAPI.loadAssetCommand(assetType: Enum.AssetType, task: Task, assetId: number, callback: (item: Instance) -> ())
Verifica que el recurso sea del tipo indicado y esté permitido, lo inserta y luego se lo pasa a tu callback para que lo coloque. Esto es lo que impulsa a ;gear.
getToolsInfoAsync Server¶
CommandAPI.getToolsInfoAsync(): (boolean, {ToolInfo} | string)
Devuelve true y el ToolInfo de cada herramienta disponible para ;give, o false y un motivo.
Utilidades¶
getTargets Server¶
CommandAPI.getTargets(targetType: "All" | "Others" | "Nearby" | "OthersNearby", originPlayer: Player?, radius: number?): {Player}
Convierte un calificador en los jugadores que abarca en este momento. "Nearby" y "OthersNearby" miden desde el jugador de origen, usando radius studs (50 por defecto).
setCameraSubject Client¶
CommandAPI.setCameraSubject(newSubject: Instance)
Apunta la cámara del jugador local a un nuevo sujeto, como el Humanoid de otro jugador para ;view.
runPromptCommand Server¶
CommandAPI.runPromptCommand(promptType: PromptType, task: Task, targets: {Player}, text: string, options: PromptOptions?)
El motor detrás de ;message, ;hint y mensajes similares. Filtra el texto, muestra el mensaje a cada objetivo y mantiene viva la tarea hasta que el mensaje expira.
runEmoteId Server¶
CommandAPI.runEmoteId(task: Task, emoteId: number, speed: number?, looped: boolean?)
Reproduce la animación del emote en el objetivo de la tarea y la termina cuando la tarea termina.
createEmoteCommand Server¶
CommandAPI.createEmoteCommand(emoteName: string, emoteId: number, properties: {[string]: any}?): Command
Devuelve un comando de emote completo, listo para agregarlo a tu array de comandos. properties sobrescribe cualquier campo del comando generado.
createBundleCommand Server¶
CommandAPI.createBundleCommand(commandName: string, bundleId: number, properties: {[string]: any}?): Command
El mismo comportamiento para comandos de paquete como ;ratdance.
bindEmotePrompt Server¶
CommandAPI.bindEmotePrompt(task: Task, target: Player, emoteId: number, emoteName: string?, isLooped: boolean?)
Vincula la tarjeta de acción del emote a la tarea, para que el objetivo pueda marcar el emote como favorito o verlo en el catálogo.
openProfile Server¶
CommandAPI.openProfile(player: Player?, userId: number)
Abre para el jugador la ventana emergente del perfil del usuario indicado.
openPage Server¶
CommandAPI.openPage(player: Player?, pageId: string, tabLabel: string?)
Abre el panel del jugador directamente en la página indicada, y opcionalmente en una de sus pestañas.
openEmotes Server¶
CommandAPI.openEmotes(player: Player?)
Abre para el jugador la ventana emergente de emotes.
colourRoleName Shared¶
CommandAPI.colourRoleName(role): string
El nombre del rol envuelto en su color, para texto enriquecido.
isTableEmpty Shared¶
CommandAPI.isTableEmpty(tbl: {[any]: any}): boolean
Indica si la tabla no tiene ninguna entrada, incluidas las de clave que #tbl no detecta.
round Shared¶
CommandAPI.round(number: number, decimalPlaces: number?): number
Redondea un número a los decimales indicados, o a un entero por defecto.
Tipos¶
Commands¶
type Commands = {Command}
El array que devuelve un módulo de comandos.
Command¶
Una tabla de comando dentro de Commands (name, args, run, etcétera). Custom Commands explica cada campo.
Task¶
El objeto de tarea que se pasa a cada función run, explicado por completo en la Task API.
ClientCommands¶
El equivalente del lado del cliente de Commands, devuelto por el módulo Client.
ClientCommand¶
Una tabla de comando del lado del cliente dentro de ClientCommands.
UserInfo¶
type UserInfo = {
userId: number | string,
userName: string,
userImage: string,
userDisplayName: string,
userTopRole: {key: string, name: string, color: Color3}?,
}
userTopRole solo está presente para los jugadores de este servidor.
ToolInfo¶
type ToolInfo = {
name: string,
textureId: string,
tool: Tool?,
}
PromptType¶
type PromptType = "info" | "success" | "warn" | "error" | "message" | "hint" | "privateMessage" | "alert" | "vote" | "voteResults" | "action"
Las cadenas de tipo de mensaje. Consulta prompt para ver qué muestra cada una.
PromptOptions¶
La tabla de opciones que acepta prompt, explicada por completo en prompt.
PromptHandle¶
El handle que devuelve prompt, que cierra el mensaje antes de tiempo con handle:Disconnect().