cw-performance — Manual

Calcula um índice de performance (PI) e uma classe (E até X) para qualquer veículo, a partir dos valores de handling, e expõe o resultado por export.

Sumário

1. Dependências
2. Instalação
3. Configuração
4. Comandos
5. Cálculo do índice
6. Display sobre os veículos
7. Entrypoints para outros recursos
8. Implementações de exemplo
9. Estrutura de arquivos

Dependências

Instalação

1. Copie a pasta cw-performance para resources/.
2. Adicione ao server.cfg:

   ensure cw-performance
3. Se for usar o display sobre os veículos ou as notificações do ox_lib, descomente a linha do ox_lib em shared_scripts no fxmanifest.lua:

   shared_scripts {
       'config.lua',
       '@ox_lib/init.lua',
   }
4. Ajuste Config.NotifySystem para o sistema de notificação do servidor (ox, qb, ou qualquer outro valor para cair no print de console).
5. Não há SQL nem itens de inventário.

Configuração

Arquivo: config.lua (shared).

Geral

Classes

Ajuste do cálculo

Display 3D (requer ox_lib)

Comandos

Cálculo do índice

Todos os valores vêm do CHandlingData do veículo, via GetVehicleHandlingFloat, mais três natives (GetVehicleAcceleration, GetVehicleEstimatedMaxSpeed, GetVehicleMaxBraking).

O PI final é floor((accel^Ba + speed^Bs + handling^Bh + braking^Bb) * ratingMultiplier), onde B* são os expoentes de Config.Balance. A classe é o maior limite de Config.Classes que o PI ultrapassa; abaixo do menor limite, cai em Config.LowestClass.

Motos não foram testadas pelo autor — o cálculo é pensado para carros.

Display sobre os veículos

Com Config.AllowDrawTextDisplay = true e o ox_lib importado no fxmanifest.lua, o jogador pode segurar o Alt esquerdo (keybind show_performance, remapeável em Pausa > Configurações > Atalhos de teclado > FiveM) para ver a classe e o PI flutuando sobre todos os veículos dentro de Config.DrawTextSetup.distance metros, além do próprio veículo.

O texto é colorido segundo Config.ClassColors e, com showPillar = true, ganha um marcador vertical ligando o carro ao rótulo. O Config.DrawTextAuthFunc é consultado no press e no release — use-o para restringir o display a mecânicos, a quem porta um item específico, etc.

Entrypoints para outros recursos

Todos os exports são do lado cliente.

-- Retorna os scores parciais, a letra da classe e o índice de performance.
-- info = { accel, speed, handling, braking, drivetrain }
-- drivetrain é o fDriveBiasFront: 0.0 = RWD, 1.0 = FWD, entre os dois = AWD.
local info, class, perfRating = exports['cw-performance']:getVehicleInfo(vehicle)
 
-- Retorna os valores brutos de handling usados no cálculo:
-- antiRoll, suspensionForce, reboundDamp, compDamp, gripLow, gripHigh,
-- lowSpeedTraction, camberStiffness, offroadGripLoss
local details = exports['cw-performance']:getVehicleDetails(vehicle)
 
-- Retorna a tabela Config.Classes (limite inferior de cada classe).
local classes = exports['cw-performance']:getPerformanceClasses()

Eventos de cliente

-- Executa o mesmo que o /checkscore: notifica classe e PI do veículo atual.
TriggerClientEvent('cw-performance:client:CheckPerformance', source)
 
-- Liga/desliga o debug em runtime.
TriggerClientEvent('cw-performance:client:toggleDebug', source, true)

Exemplo de uso:

local vehicle = GetVehiclePedIsUsing(PlayerPedId())
local info, class, perfRating = exports['cw-performance']:getVehicleInfo(vehicle)
print('CLASSE', class)
print('PI', perfRating)
print('INFO', json.encode(info, { indent = true }))

Implementações de exemplo

A pasta implementations/ traz os arquivos de um app de celular (qb-phone) que exibe os scores do último veículo do jogador. Não é carregado pelo fxmanifest.lua — são arquivos para copiar manualmente para o recurso do celular, seguindo o implementations/README.md. O próprio autor marca essa implementação como datada e recomenda montar o display a partir do retorno de getVehicleInfo.

Estrutura de arquivos

cw-performance/
├── client/
│   ├── client.lua                — cálculo do PI, exports, comando /checkscore e notificações
│   └── drawtextDisplaying.lua    — keybind e display 3D de classe/PI sobre veículos próximos (requer ox_lib)
├── implementations/
│   ├── README.md                 — passo a passo para instalar o app de celular no qb-phone
│   └── html/
│       ├── css/tuner.css         — estilos do app
│       ├── js/tuner.js           — lógica do app
│       └── img/RSL.png           — ícone do app
├── config.lua                    — classes, balanceamento, mods do cálculo e setup do display
└── fxmanifest.lua                — dependency oxmysql; import do ox_lib vem comentado