Configuração

Tudo é configurado em config.lua. Esta página detalha cada opção.

Geral

config.lua

Config.Framework = 'qbox'    -- qbox / qbcore / esx / standalone
Config.Command   = 'animpos' -- chat command name
Config.Cooldown  = 15        -- cooldown between uses (seconds)

Framework — seleciona o resource principal e quais restrições de metadados se aplicam.
Command — o comando de chat que abre a ferramenta (também usado como o nome do mapeamento de tecla).
Cooldown — segundos mínimos entre os usos.

Atalho de Tecla

Permite que os jogadores abram a ferramenta com uma tecla, reconfigurável nas configurações do GTA V.

config.lua

Config.Keybind = {
    Enabled = true,
    Default = 'F6',  -- default key (empty for none; player can rebind)
}

ℹ

O mapeamento de tecla só é registrado quando Enabled = true e Default não estiver vazio. Os jogadores podem sempre reconfigurá-lo em Configurações → Atalhos de Tecla → FiveM.

Permissão (opcional)

Restrinja quem pode usar a ferramenta. Desativado por padrão.

config.lua

Config.Permission = {
    Enabled = false,
    Type    = 'ace',                     -- 'ace' / 'job'
    Ace     = 'animpos.use',             -- used when Type == 'ace'
    Jobs    = { 'police', 'ambulance' }, -- used when Type == 'job'
}

ace — verificado no lado do servidor via IsPlayerAceAllowed através de um callback do ox_lib (mais seguro). Conceda com add_ace ... animpos.use allow.
job — o cargo (job) do framework do jogador deve estar na lista Jobs (QBox / QB-Core / ESX).

Restrições

Bloqueie o uso enquanto o jogador estiver em determinados estados. As verificações nativas funcionam em todos os frameworks; as verificações de metadados aplicam-se apenas a QBox e QB-Core.

config.lua

Config.Restrictions = {
    -- Framework based (qbox / qbcore only)
    CheckDead        = true,   -- block while dead
    CheckLastStand   = true,   -- block while in last stand
    CheckHandcuffed  = true,   -- block while handcuffed

    -- Native based (works on ALL frameworks incl. standalone)
    CheckInVehicle   = true,   -- block while inside a vehicle
    CheckFalling     = true,   -- block while falling / parachuting
    CheckSwimming    = false,  -- block while swimming

    -- Metadata field names read from the player data
    MetaKeys = {
        Dead       = 'isdead',
        LastStand  = 'inlaststand',
        Handcuffed = 'ishandcuffed',
    },
}

⚠

MetaKeys correspondem aos nomes dos campos de metadados nos dados de jogador do seu framework. Se o seu core (ou um pacote personalizado) armazenar isso com chaves diferentes, altere-as aqui para que as verificações de morte / último estado / algemado leiam os valores corretos.

Notificações

Escolha o sistema usado para cada mensagem.

config.lua

Config.Notify = 'ox_lib'  -- 'ox_lib' / 'qbcore' / 'esx' / 'custom'

-- Only used when Config.Notify == 'custom'.
-- ntype is one of: 'success' / 'error' / 'primary' / 'inform'
Config.CustomNotify = function(message, ntype)
    -- exports['my-notify']:SendAlert(message, ntype)
end

ox_lib — lib.notify (padrão).
qbcore — evento QBCore:Notify.
esx — evento esx:showNotification.
custom — seu próprio manipulador em Config.CustomNotify.

ℹ

Um valor inválido em Config.Notify registra um aviso no console do servidor e retorna com segurança para o ox_lib.

UI

config.lua

Config.UI = {
    Position = 'right',       -- left / right / center
    OffsetX  = 30,            -- distance from the edge (px)
    OffsetY  = 0,             -- vertical offset (px)
    AccentColor = '#f4cb98',  -- accent colour for key highlights / glow
    ShowHeader = true,        -- show the title/subtitle header
    ShowTip    = true,        -- show the bottom tip line
    ShowAnimations = true,    -- key press animations
    AnimationType = {
        Movement = 'pulse',   -- pulse / glow
        Action   = 'glow',    -- pulse / glow
    }
}

Movimento

config.lua

Config.Movement = {
    Speed         = 0.01,  -- movement speed
    RotationSpeed = 0.5,   -- rotation speed
    MaxDistance   = 5.0,   -- max distance from start (m)
    MaxHeight     = 3.5,   -- max height above start (m)
    MinHeight     = -3.5,  -- min height below start (m)
    PrecisionMultiplier = 0.25, -- speed multiplier while holding Precision
}

Desempenho

config.lua

Config.Performance = {
    NetworkUpdateDelay = 50,   -- network sync delay (ms)
    LoopWait           = 0,    -- main loop wait (ms)
    AnimationDuration  = 300,  -- UI animation duration (ms)
    SyncCooldown       = 50,   -- server-side anti-spam sync cooldown (ms)
}

AnimationDuration é passado para a UI como a duração da transição do painel. Os valores relacionados à sincronização controlam com que frequência as atualizações de posição são enviadas e aceitas.

Sons

Sons de interface do GTA V opcionais para abrir / confirmar / cancelar / redefinir.

config.lua

Config.Sounds = {
    Enabled = true,
    Open    = { name = 'SELECT',        set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
    Confirm = { name = 'SELECT',        set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
    Cancel  = { name = 'CANCEL',        set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
    Reset   = { name = 'RESET_PROMPTS', set = 'HUD_FRONTEND_DEFAULT_SOUNDSET' },
}

Defina Enabled = false para silenciar todos os sons.

Hook CanUse

Uma verificação personalizada executada toda vez que um jogador tenta abrir a ferramenta. Retorne true para permitir, ou false (opcionalmente com uma string de mensagem) para bloquear.

config.lua

Config.CanUse = function()
    -- Example: block while taking damage
    -- local ped = PlayerPedId()
    -- if HasEntityBeenDamagedByAnyPed(ped) then
    --     return false, 'You cannot do this while taking damage!'
    -- end
    return true
end

Controles

Os códigos das teclas de controle também são totalmente configuráveis em Config.Controls (frente, trás, cima, baixo, esquerda, direita, girar, confirmar, cancelar + duas alternativas, redefinir e precisão). Consulte a página Usage & Controls para ver o layout padrão.

PreviousUsage & Controls Next Integrations