Pular para conteúdo

Usando a API

As partes internas do HD Admin mudam o tempo todo, então é essencial que o código do seu jogo nunca mexa diretamente em nada dentro do MainModule. É aí que as APIs ajudam. Elas encapsulam comportamentos úteis em funções que continuam iguais, para que o seu código não quebre em atualizações futuras.

Obtendo a API

A partir de um Script do servidor:

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

A partir de um LocalScript do cliente:

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

A partir de um módulo de comando (ConfigCommands):

local CommandAPI = require(script:FindFirstAncestor("HD Admin").Core.CommandAPI)

Isso funciona, não importa onde o seu modelo esteja, porque o HD Admin move os arquivos compartilhados dele para o ReplicatedStorage quando o jogo começa.

Tip

Se você quiser verificação de tipos e autocompletar ao usar a API, mova o seu modelo do HD Admin para o ReplicatedStorage


Páginas de referência

Task API O objeto de tarefa que os seus comandos recebem
Command API Tudo que um módulo de comando pode referenciar com segurança
Server API Comandos, cargos, moderação, emotes, prompts e configurações a partir de Scripts do servidor
Client API O painel, os prompts e as configurações a partir de LocalScripts

Info

Se você quiser que outra função/evento da API seja adicionado, compartilhe com a gente no quadro de Sugestões.