📗snt-hud

» Eventos

--------------------------------------------

# Alterar a visibilidade da hud (esconder/mostrar)
-- Por padrão, a hud é iniciada desativada, para não sobrepor criação/seleção de persoangens, utilize o evento abaixo para ativa-lá após a criação/seleção do personagem.

- Evento(s): 'toggleHud'
- Versão: client
- Parâmetros: -- em ordem
    * toggle (boolean) - definir como visivel ou não.

--------------------------------------------

# Atualizar os valores dos status essenciais (fome, sede, stress)

- Evento(s): 'hud/setHunger', 'hud/setThirst', 'hud/setStress'
- Versão: client
- Parâmetros: -- em ordem
    * value (integer) - definir o valor do status, porcentagem.

- Representação das porcentagens (value):
    * fome: 100% = circulo cheio | 0% = circulo vazio
    * sede: 100% = circulo cheio | 0% = circulo vazio
    * stress: 100% = circulo cheio | 0% = circulo vazio/não visível.

---------------------------------------------

# Barras de Progresso

- Evento(s): 'Progress', 'cancelProgress'
- Versão: client
- Parâmetros: -- em ordem
    * time (integer) - tempo em segundos ou millisegundos. 
    * text (string) - texto * opcional, caso não passado será usado 'Progreso'.

---------------------------------------------

# Alteração de variáveis (css) via evento

- Evento(s): 'hud/UI/setVariable'
- Versão: client
- Parâmetros: -- em ordem
    * variable (string) - variável, sem '--', conforme cadastrada em 'styles.css'.
    * value (string) - valor a ser definido para a variável.

- Exemplo:
    TriggerEvent('hud/UI/setVariable','healthFillColor','rgb(0,255,0)')
    -- Altera a cor de preenchimento da vida para verde.

---------------------------------------------

# Altenar a persistência do mapa

- Evento(s): 'hud/toggleMapPersistance'
- Versão: client
- Parâmetros: N/A

    - Exemplo:
    TriggerEvent('hud/toggleMapPersistance') -- alterna a opção mapa sempre ativo.

---------------------------------------------

» Exports

--------------------------------------------

# Instanciando o resource

SNT_HUD = exports['snt-hud']

--------------------------------------------

# Criação de requests (aceitar/negar)

- Export: SNT_HUD:createRequest(src,title,text)
- Versão: server
- Parâmetros: -- em ordem
    * src (integer) - source do jogador.
    * variable (string) - variável, sem '--', conforme cadastrada em 'styles.css'.
    * value (string) - valor a ser definido para a variável.

--------------------------------------------

# Criação de prompts (caixas de texto)

- Export: SNT_HUD:createPrompt(src,title,default)
- Versão: server
- Parâmetros: -- em ordem
    * src (integer) - source do jogador.
    * title (string) - título da caixa.
    * default (string) - valor padrão da caixa.

--------------------------------------------

# Abastecimento de nitro para veículos

- Export: SNT_HUD:fuelVehicleNitro(network,amount)
- Versão: server
- Parâmetros: -- em ordem
    * network (integer) - network id do veículo a ser abastecido.
    * amount (number) - quantidade de nitro a ser inserida (MAX: 1000)
  
--------------------------------------------

# Criando chamados na Central de Chamados

- Export: SNT_HUD:createCall(target,data)
- Versão: server
- Parâmetros: -- em ordem
    * target (integer || string) - source do jogador ou permissão.
    * data (table) - dados do chamado.

- Exemplo:

    local data = {
        title = 'Título do Chamado',
        description = 'Descrição do Chamado',     
        coords = {x,y,z}, -- Coordenadas do chamado.
        author = ID, -- integer (id do personagem que fez este chamado). * opcional
        color = 'rgb(r,g,b)' -- Cor do chamado. * opcional
    }
    
    SNT_HUD:createCall(src,data) -- envia este chamado para um jogador específico.
    
    SNT_HUD:createCall('police',data) -- envia para todos com a permissão 'police'.

    -- Parâmetros OPCIONAIS:
    -- * author: caso seja enviado, mostrará o nome do autor e habilitará a ligação.
    -- * color: cor da caixa do request / cor da caixa na central de chamados.

--------------------------------------------

» Chat / 3D Chat

# Para poder utilizar o chat, o player deve possuir o state 'characterId' definido.
-- Recomendamos realizar a setagem do state após a seleção do personagem, via server:

- Exemplo:
Player(src).state:set('characterId',id,true)

-- Isso serve para que o jogador não receba mensagens que são globais durante a criação de personagem, por exemplo!