Server API
Todo lo de esta página está en CoreServerAPI y se ejecuta desde un Script del servidor:
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd.Core.ServerAPI)
Comandos¶
requestCommand Server¶
ServerAPI.requestCommand(message: string, fromPlayer: Player?): (boolean, {any}, {Task})
Ejecuta un mensaje de comando exactamente como si se hubiera escrito en el chat. Si no das ningún jugador, un Server User ocupa el lugar de quien llama, así que puedes lanzar comandos desde cualquier parte del código de tu juego sin comprobaciones de permisos. Si das un jugador, se aplican sus roles, permisos y límites de frecuencia, y los avisos para quien llama se le envían a él. Devuelve si fue aprobado, los avisos generados y las tareas que creó.
-- Run as the server
ServerAPI.requestCommand(";fly all")
-- Or on behalf of a player
ServerAPI.requestCommand(";fly me", player)
getTasks Server¶
ServerAPI.getTasks(commandName: string?, target: Target?): {Task}
Devuelve las tareas en ejecución. Los dos filtros son opcionales. ServerAPI.getTasks() devuelve todas las tareas, ServerAPI.getTasks("fly") todas las tareas de fly, y ServerAPI.getTasks("fly", player) solo las tareas de fly de ese jugador.
endTasks Server¶
ServerAPI.endTasks(commandName: string?, target: Target?): number
Termina las tareas que coinciden y devuelve cuántas terminó. Es ;unCommand en forma de código, con los mismos filtros opcionales que getTasks.
-- End every fly in the server
ServerAPI.endTasks("fly")
-- Clear everything running on one player
ServerAPI.endTasks(nil, player)
canUseCommandAsync Server¶
ServerAPI.canUseCommandAsync(target: Target, commandName: string): (boolean, string?)
Indica si los roles del objetivo le permiten ejecutar el comando dado. Devuelve true, o false y el motivo.
disableCommands Server¶
ServerAPI.disableCommands(player: Player)
Impide que el jugador ejecute comandos nuevos hasta que se llame a enableCommands o vuelva a entrar. Es útil mientras está en una ronda de minijuego o en una escena cinemática. Sus tareas que ya están en ejecución continúan, así que combínalo con endTasks si quieres terminarlas también. Es seguro llamarlo directamente desde PlayerAdded.
enableCommands Server¶
ServerAPI.enableCommands(player: Player)
Permite que el jugador vuelva a ejecutar comandos.
Roles¶
Los nombres de rol no distinguen entre mayúsculas y minúsculas, así que "VIP" y "vip" llegan al mismo rol.
giveRoleAsync Server¶
ServerAPI.giveRoleAsync(target: Target, roleName: string, options: ActionOptions?): (boolean, string?)
Da el rol al objetivo y devuelve true, o false y el motivo por el que no se pudo. Los roles permanentes se guardan, viajan entre servidores y también funcionan con objetivos que están desconectados.
| Option | What it does |
|---|---|
scope |
"perm" guarda para siempre (el valor por defecto), "server" dura solo en este servidor, "expire" se quita solo después de duration |
duration |
Segundos, obligatorio para el alcance "expire" |
reason |
El motivo para darlo |
callerUserId |
El UserId de la persona que lo dio y contra el que se comprueba el rango |
-- Reward a purchase forever
ServerAPI.giveRoleAsync(player, "VIP")
-- A 24 hour trial, granted by an offline head admin
ServerAPI.giveRoleAsync(player, "Mod", {
scope = "expire",
duration = 24 * 3600,
callerUserId = 1234567,
})
takeRoleAsync Server¶
ServerAPI.takeRoleAsync(target: Target, roleName: string, options: ActionOptions?): (boolean, string?)
Quita el rol al objetivo, incluidos los roles permanentes dados en otros servidores o mientras estaba desconectado. options acepta scope ("perm" o "server") y callerUserId, igual que giveRoleAsync.
getRolesAsync Server¶
ServerAPI.getRolesAsync(target: Target): (boolean, {Role} | string)
Devuelve true y los roles del objetivo ordenados del rango más alto al más bajo, o false y un motivo. El objetivo debe estar en este servidor.
local success, roles = ServerAPI.getRolesAsync(player)
if success then
for _, role in roles do
print(role.name, role.rank)
end
end
getTopRoleAsync Server¶
ServerAPI.getTopRoleAsync(target: Target): (boolean, (Role | string)?)
Devuelve true y el rol de mayor rango del objetivo (nil si no tiene ninguno), o false y un motivo. El objetivo debe estar en este servidor.
hasRoleAsync Server¶
ServerAPI.hasRoleAsync(target: Target, roleName: string): boolean
Indica si el objetivo tiene el rol en este momento. El objetivo debe estar en este servidor.
getRole Server¶
ServerAPI.getRole(roleName: string): Role?
Devuelve el Role con el nombre dado, o nil si ningún rol coincide.
getAllRoles Server¶
ServerAPI.getAllRoles(): {Role}
Devuelve todos los roles de la configuración del juego.
Moderación¶
banAsync Server¶
ServerAPI.banAsync(target: Target, options: BanOptions): (boolean, string?)
Veta al objetivo para que no entre a tu juego, y lo expulsa si está en cualquier servidor. Devuelve true y el nuevo banId, o false y el motivo por el que no se pudo. También funciona con objetivos desconectados.
| Option | What it does |
|---|---|
reason |
Obligatorio, se muestra al jugador cuando intenta entrar |
scope |
"perm" (el valor por defecto), "server" solo para este servidor, o "expire" |
duration |
Segundos, para el alcance "expire" |
expiresAt |
Una época absoluta que reemplaza a duration |
banAlts |
Por defecto es true, y veta las cuentas alternas mediante el BanService de Roblox |
callerUserId |
Un UserId al que se atribuye el veto y contra el que se comprueba el rango. Omítelo para un veto del sistema sin restricciones |
-- A 7 day ban issued by your own anti-cheat
ServerAPI.banAsync(player, {
reason = "Exploiting",
scope = "expire",
duration = 7 * 24 * 3600,
})
unbanAsync Server¶
ServerAPI.unbanAsync(target: Target, banId: string?, options: UnbanOptions?): (boolean, string?, number?)
Quita los vetos del objetivo y devuelve (success, failReason, totalBansCleared). Pasa un banId para quitar un veto concreto, o nil para quitarlos todos. options acepta scope y callerUserId.
getBanAsync Server¶
ServerAPI.getBanAsync(target: Target): (BanRecord?, string?)
Devuelve el BanRecord activo del objetivo y su banId, revisando también los registros de jugadores desconectados, o nil si no está vetado.
local ban, banId = ServerAPI.getBanAsync(userId)
if ban then
print(`Banned for '{ban.reason}' by {ban.bannedBy}`)
end
Mensajes¶
prompt Shared¶
ServerAPI.prompt(promptType: PromptType, player: Player, text: string, options: PromptOptions?): PromptHandle
Muestra un aviso, un mensaje o una tarjeta al jugador con la propia interfaz de HD Admin, desde cualquier Script del servidor. Es la misma función que el prompt de la API de comandos, que cubre todos los tipos de mensaje, la lista completa de opciones y las tarjetas de acción con botones y controles deslizantes.
ServerAPI.prompt("success", player, "Quest complete!", {duration = 5})
Texto¶
filterTextAsync Server¶
ServerAPI.filterTextAsync(text: string, author: Target, viewer: Target?): (boolean, string)
Pasa el texto por el filtro de Roblox y devuelve true y el texto filtrado, o false y el motivo. Omite viewer para filtrar para todos, que es lo correcto para cualquier cosa que puedan ver todos los jugadores y para el texto que guardes. Pasa un viewer para filtrar solo para ese jugador. El autor debe estar en este servidor, porque el filtro de Roblox se niega a ejecutarse para quien no lo esté. El texto que vuelve como puros hashtags cuenta como un fallo, así que nunca muestras un resultado vacío.
local success, result = ServerAPI.filterTextAsync(petName, player)
if success then
nameLabel.Text = result
else
ServerAPI.prompt("warn", player, "That name can't be used")
end
Información¶
getSetting Shared¶
ServerAPI.getSetting(settingName: string, player: Player?): any
Devuelve el valor de un ajuste del juego, como ServerAPI.getSetting("Prefix"). Pasa un jugador para aplicar también sus propios You Settings, y así obtener el valor exacto que ve ese jugador.
getVersion Shared¶
ServerAPI.getVersion(): string
La versión de HD Admin en ejecución, como "v2.0.0".
Aislamiento¶
isolateServer Server¶
ServerAPI.isolateServer()
Corta a este servidor la posibilidad de guardar datos y de enviar nada a otros servidores. Todo seguirá pareciendo funcionar con normalidad, como los vetos permanentes, la edición de roles, los ajustes del juego, los comandos globales y las votaciones globales, solo que nada se guarda ni llega a otros servidores, así que todo desaparece cuando el servidor termina. Los datos guardados se siguen leyendo con normalidad, así que el servidor arranca con tus roles, vetos, ajustes, etc. reales. Las preferencias de cada jugador, como sus You settings y sus emotes favoritos, sí se siguen guardando porque solo le afectan a ese jugador.
Esto es útil para servidores privados o servidores reservados donde quieres dar "Owner" a alguien sin afectar al resto de tu universo.
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd:WaitForChild("Core"):WaitForChild("ServerAPI"))
ServerAPI.isolateServer()
isServerIsolated Server¶
ServerAPI.isServerIsolated(): boolean
Devuelve true una vez que se ha llamado a isolateServer en este servidor.
Restricción¶
restrictServer Server¶
ServerAPI.restrictServer(options: RestrictOptions?)
Esto restringe todas las características que afectan a todo el juego, incluidos los ajustes del juego, la edición de roles, los roles permanentes, los vetos y desvetos permanentes, las votaciones, las tareas guardadas, y los modificadores perm, global y join. Los comandos de los roles en commandsInRoles o nombrados en commands también se restringen. Todo sigue apareciendo con normalidad en el panel hasta que se usa la característica o el comando en cuestión, y entonces se muestra un aviso de error. Quien tenga un rol en bypassRoles se salta todas las restricciones.
A diferencia de isolateServer, los datos sí se guardan y sí llegan a otros servidores. El HD Admin Hub lo usa, por ejemplo, para dar "Dev" a todos los jugadores y mostrar el panel de administración, pero restringe muchos de los comandos y características abusivos para evitar que destruyan los servidores.
| Option | What it does |
|---|---|
commandsInRoles |
Nombres o claves de rol cuyos comandos se rechazan |
commands |
Nombres o claves de comando que se rechazan además de esos |
bypassRoles |
Nombres o claves de rol que se saltan todas las restricciones |
warning |
Reemplaza "This is restricted in this game", el aviso que se muestra cada vez que se rechaza algo |
local hd = game:GetService("ReplicatedStorage"):WaitForChild("HD Admin")
local ServerAPI = require(hd:WaitForChild("Core"):WaitForChild("ServerAPI"))
ServerAPI.restrictServer({
commandsInRoles = {"Dev", "Owner"},
commands = {"BuildingTools", "Music"},
bypassRoles = {"Owner"},
warning = "This is restricted in this demo",
})
isServerRestricted Server¶
ServerAPI.isServerRestricted(): boolean
Devuelve true una vez que se ha llamado a restrictServer en este servidor.
Emotes¶
getEmoteById Server¶
ServerAPI.getEmoteById(emoteId: number): Emote?
Devuelve el Emote registrado con el id dado, o nil.
getEmoteByName Server¶
ServerAPI.getEmoteByName(emoteName: string, matchLength: boolean?): Emote?
Devuelve el Emote registrado que coincide con el nombre dado, o nil.
getRandomEmote Server¶
ServerAPI.getRandomEmote(): Emote?
addEmoteAsync Server¶
ServerAPI.addEmoteAsync(emote: IncompleteEmote, dontRegister: boolean?): (boolean, Emote | string)
Registra un emote nuevo a partir de un recurso de animación de emote, para que se pueda reproducir con ;emote y aparezca en el menú de emotes. Solo emoteId es obligatorio, y los datos que falten se obtienen por ti. Devuelve true y el Emote completo, o false y el motivo por el que no se pudo.
Tipos¶
Role¶
La tabla completa de configuración de un rol, tal como se define en ConfigRoles. Consulta Roles.
BanRecord¶
type BanRecord = {
type: "perm" | "expire" | "server",
source: "admin" | "loader",
bannedBy: number | string,
bannedAt: number,
expiresAt: number?,
grantedOnJobId: string?, -- only present on server-scope bans
reason: string,
banAlts: boolean,
}
El banId no forma parte del registro en sí, así que getBanAsync te lo entrega como segundo valor de retorno.
Task¶
Consulta Task API.
Emote¶
type Emote = {
name: string,
originalName: string?,
order: number,
animationId: number,
emoteId: number,
}