Models

Reference for the models API.

Functions

models.peds

Returns a list of ped models.

---@param limit? integer
function models.peds(limit?): number[]

models.weapons

Returns a list of weapon models.

---@param limit? integer
function models.weapons(limit?): number[]

models.vehicles

Returns a list of vehicle models.

---@param limit? integer
function models.vehicles(limit?): number[]

models.vehicles_from_dlc

Returns a list of vehicle models from a DLC.

---@param name string
function models.vehicles_from_dlc(name): number[]

models.vehicles_from_class

Returns a list of vehicle models from a class.

---@param class models.vehicle
function models.vehicles_from_class(class): number[]

Constants

vehicle

models.vehicle.compacts
models.vehicle.sedans
models.vehicle.suvs
models.vehicle.coupes
models.vehicle.muscle
models.vehicle.sports_classics
models.vehicle.sports
models.vehicle.super
models.vehicle.motorcycles
models.vehicle.off_road
models.vehicle.industrial
models.vehicle.utility
models.vehicle.vans
models.vehicle.cycles
models.vehicle.boats
models.vehicle.helicopters
models.vehicle.planes
models.vehicle.service
models.vehicle.emergency
models.vehicle.military
models.vehicle.commercial
models.vehicle.trains
models.vehicle.open_wheel

dlc

"A Safehouse in The Hills"
"Money Fronts"
"Expanded & Enhanced"
"Agents of Sabotage"
"Bottom Dollar Bounties"
"The Chop Shop"
"San Andreas Mercenaries"
"Los Santos Drug Wars"
"The Criminal Enterprises"
"The Contract"
"Los Santos Tuners"
"The Cayo Perico Heist"
"Los Santos Summer"
"The Diamond Casino Heist"
"The Diamond Casino & Resort"
"Arena War"
"After Hours"
"Southern San Andreas Super Sport Series"
"The Doomsday Heist"
"Smuggler's Run"
"Gunrunning"
"Cunning Stunts: Special Vehicle Circuit"
"Import/Export"
"Bikers"
"Cunning Stunts"
"Further Adventures In Finance & Felony"
"Lowriders: Custom Classics"
"Be My Valentine"
"Drop Zone"
"Festive Surprise 2015"
"Executives & Other Criminals"
"Halloween Surprise"
"Lowriders"
"Ill-Gotten Gains Part 2"
"Ill-Gotten Gains Part 1"
"Heists"
"Festive Surprise"
"Last Team Standing"
"San Andreas Flight School"
"Independence Day"
"I'm Not a Hipster"
"The High Life"
"Business"
"Valentine's Day Massacre"
"Beach Bum"

Examples

print('super vehicle count: ' .. tostring(#models.vehicles_from_class(models.vehicle.super)))
print('money fronts vehicle count: ' .. tostring(#models.vehicles_from_dlc('Money Fronts')))
print('total vehicle count: ' .. tostring(#models.vehicles()))
print('ped count: ' .. tostring(#models.peds()))
print('weapon count: ' .. tostring(#models.weapons()))