Exports

Os exports permitem integrar o dk_dances com o resto do servidor: abrir o menu a partir de um NPC ou de um item, tocar uma dança por script, saber se o jogador está dançando, registrar as animações de outro recurso. O arquivo types.lua do recurso descreve todos os exports para o Lua LSP. Ele não é carregado em runtime — serve só para o seu editor sugerir e validar as assinaturas enquanto você escreve a integração.

Client

Export	Assinatura	Retorno
`openMenu`	`openMenu(id?: string)`	`boolean`
`closeMenu`	`closeMenu()`	`boolean`
`openShortcuts`	`openShortcuts()`	`boolean`
`play`	`play(id: string)`	`boolean, motivo?`
`stop`	`stop()`	`boolean`
`isDancing`	`isDancing()`	`boolean`
`isLoaded`	`isLoaded(id: string)`	`boolean`
`load`	`load(id: string)`	`boolean`

openMenu / closeMenu

Abrem e fecham o menu de danças. Com o id de uma dança, o menu abre com ela selecionada.O hook onOpenUi pode negar a abertura.

openShortcuts

Abre a barra de atalhos. Devolve false se ela estiver desligada (shortcuts.enabled), se o menu já estiver aberto ou se o hook onOpenUi negar.

play

Toca a dança do id, como o comando /danca <id>.Retorna true, ou false e o motivo.

stop

Para a dança atual. É o que um script externo chama quando termina uma dança que chama outro script.

isDancing

Retorna true enquanto o jogador local está dançando.

isLoaded / load

isLoaded diz se o arquivo da dança já está baixado. load espera o download e devolve o resultado: use para pré-carregar uma dança antes de tocar.

Server

Export	Assinatura	Retorno
`isDancing`	`isDancing(src: number)`	`boolean`
`registerDance`	`registerDance(dance: DkDance)`	`boolean, motivo?`
`unregisterDance`	`unregisterDance(id: string)`	`boolean, motivo?`

isDancing

Retorna true se o jogador src está dançando.

registerDance

Põe uma dança no menu. Sempre local: file e remote são ignorados. Retorna false e o motivo se a dança for recusada.Veja Injetar animações do seu servidor.

unregisterDance

Tira do menu uma dança que o mesmo recurso registrou. Retorna false e o motivo se não puder remover.

Só o servidor registra danças. O client não tem export de registro, então nenhum jogador consegue colocar uma dança no catálogo.

Exemplos

exports.dk_dances:openMenu()

exports.dk_dances:openMenu("passinho_i_love_u_funk")

Tocar uma dança por script

local ok, reason = exports.dk_dances:play("gta-shuffle-high-left-up")

if not ok then
    print(("Não deu para dançar: %s"):format(reason))
end

Parar a dança quando outra coisa precisa do jogador

if exports.dk_dances:isDancing() then
    exports.dk_dances:stop()
end

Pré-carregar antes de tocar

exports.dk_dances:load("passinho_i_love_u_funk")
exports.dk_dances:play("passinho_i_love_u_funk")

Saber, no servidor, se um jogador está dançando

if exports.dk_dances:isDancing(source) then
    return
end

Registrar uma dança de outro recurso

local ok, problem = exports.dk_dances:registerDance({
    id = "meupack-samba",
    label = "Samba do Zé",
    dict = "meupack@samba",
    clip = "samba_1",
    category = "party",
    origin = "exclusive",
    loop = true,
})

if not ok then
    print(("dk_dances recusou a dança: %s"):format(problem))
end

Hooks

Reaja a início, fim e compartilhamento.

Injetar animações

Registre as animações do seu servidor no menu.

Informações Gerais

Scripts

Client

Server

Exemplos

Abrir o menu a partir de um NPC

Abrir o menu já em uma dança

Tocar uma dança por script

Parar a dança quando outra coisa precisa do jogador

Pré-carregar antes de tocar

Saber, no servidor, se um jogador está dançando

Registrar uma dança de outro recurso

Hooks

Injetar animações

​Client

​Server

​Exemplos

​Abrir o menu a partir de um NPC

​Abrir o menu já em uma dança

​Tocar uma dança por script

​Parar a dança quando outra coisa precisa do jogador

​Pré-carregar antes de tocar

​Saber, no servidor, se um jogador está dançando

​Registrar uma dança de outro recurso

Hooks

Injetar animações

Client

Server

Exemplos

Abrir o menu a partir de um NPC

Abrir o menu já em uma dança

Tocar uma dança por script

Parar a dança quando outra coisa precisa do jogador

Pré-carregar antes de tocar

Saber, no servidor, se um jogador está dançando

Registrar uma dança de outro recurso