Noir
  • 🚶‍♂️Intro
  • 📁Tutorials
    • 🎓Starting Noir
    • 📖Libraries
    • 🖥️Services
    • ❔Libraries VS Services
    • 💬Callbacks
    • 💥Classes
    • 🔎Debugging
  • 📚Examples
  • ☄️API Reference
    • Bootstrapper
    • Built-Ins
      • Classes
        • AITarget
        • Body
        • Command
        • Connection
        • Event
        • HTTPRequest
        • HTTPResponse
        • Library
        • Message
        • Object
        • Player
        • Service
        • Task
        • TickIterationProcess
        • Tracker
        • Vehicle
        • Widgets
          • MapLabelWidget
          • MapLineWidget
          • MapObjectWidget
          • PopupWidget
          • ScreenPopupWidget
          • Widget
      • Libraries
        • Base64
        • Dataclasses
        • Deprecation
        • Events
        • HTTP
        • JSON
        • Logging
        • Matrix
        • Number
        • String
        • Table
      • Services
        • CommandService
        • GameSettingsService
        • HTTPService
        • MessageService
        • NotificationService
        • ObjectService
        • PlayerService
        • TaskService
        • TPSService
        • UIService
        • VehicleService
    • Callbacks
    • Class
    • Classes
    • Debugging
    • Definition
    • Libraries
    • Noir
    • Services
    • TypeChecking
Powered by GitBook
On this page
  • Parameters
  • Returns
  • Parameters
  • Parameters
  • Parameters
  • Parameters
  • Returns
  • Parameters
  • Parameters
  • Parameters
  • Parameters
  • Parameters
  • Parameters
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Returns
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Returns
Edit on GitHub
  1. API Reference
  2. Built-Ins
  3. Services

VehicleService

Noir.Services.VehicleService: NoirService

A service for interacting with vehicles.

Note that vehicles are referred to as bodies, while vehicle groups are referred to as vehicles.

Noir.Services.VehicleService:_LoadSavedVehicles()

Load all saved vehicles. It is important bodies are loaded beforehand. If this is not the case, they will be created automatically but possibly with incorrect data.

Used internally.

Noir.Services.VehicleService:_LoadSavedBodies()

Load all saved bodies.

Used internally.

Noir.Services.VehicleService:_RegisterVehicle(ID, player, spawnPosition, cost, fireEvent)

Register a vehicle to the vehicle service.

Used internally.

Parameters

  • ID: integer

  • player: NoirPlayer|nil

  • spawnPosition: SWMatrix

  • cost: number

  • fireEvent: boolean

Returns

  • NoirVehicle

Noir.Services.VehicleService:_SaveVehicle(vehicle)

Save a vehicle.

Used internally.

Parameters

  • vehicle: NoirVehicle

Noir.Services.VehicleService:_UnsaveVehicle(vehicle)

Unsave a vehicle.

Used internally.

Parameters

  • vehicle: NoirVehicle

Noir.Services.VehicleService:_UnregisterVehicle(vehicle, fireEvent)

Unregister a vehicle from the vehicle service.

Used internally.

Parameters

  • vehicle: NoirVehicle

  • fireEvent: boolean

Noir.Services.VehicleService:_RegisterBody(ID, player, fireEvent)

Register a body to the vehicle service.

Used internally.

Parameters

  • ID: integer

  • player: NoirPlayer|nil

  • fireEvent: boolean

Returns

  • NoirBody|nil

Noir.Services.VehicleService:_SaveBody(body)

Save a body.

Used internally.

Parameters

  • body: NoirBody

Noir.Services.VehicleService:_UnsaveBody(body)

Unsave a body.

Used internally.

Parameters

  • body: NoirBody

Noir.Services.VehicleService:_LoadBody(body, fireEvent)

Load a body internally.

Used internally.

Parameters

  • body: NoirBody

  • fireEvent: boolean

Noir.Services.VehicleService:_UnloadBody(body, fireEvent)

Unload a body internally.

Used internally.

Parameters

  • body: NoirBody

  • fireEvent: boolean

Noir.Services.VehicleService:_DamageBody(body, x, y, z, damage)

Fire events for body damage.

Used internally.

Parameters

  • body: NoirBody

  • x: number

  • y: number

  • z: number

  • damage: number

Noir.Services.VehicleService:_UnregisterBody(body, autoDespawnParentVehicle, fireEvent)

Unregister a body from the vehicle service.

Used internally.

Parameters

  • body: NoirBody

  • autoDespawnParentVehicle: boolean

  • fireEvent: boolean

Noir.Services.VehicleService:_SetupVehicle(primaryVehicleID, vehicleIDs, position)

Setup data for a spawned vehicle.

Parameters

  • primaryVehicleID: integer

  • vehicleIDs: table<integer, integer>

  • position: SWMatrix

Returns

  • NoirVehicle

Noir.Services.VehicleService:SpawnVehicleFromMissionComponent(componentID, locationID, position, addonIndex)

Spawn a vehicle from a mission component.

Uses server.spawnAddonComponent under the hood.

Parameters

  • componentID: integer

  • locationID: integer

  • position: SWMatrix

  • addonIndex: integer|nil - Defaults to this addon's index

Returns

  • NoirVehicle

Noir.Services.VehicleService:SpawnVehicleByFileName(fileName, position)

Spawn a vehicle by file name.

Uses server.spawnVehicle under the hood.

Parameters

  • fileName: string

  • position: SWMatrix

Returns

  • NoirVehicle

Noir.Services.VehicleService:SpawnVehicle(componentID, position, addonIndex)

Spawn a vehicle.

Uses server.spawnAddonVehicle under the hood.

Parameters

  • componentID: integer

  • position: SWMatrix

  • addonIndex: integer|nil - Defaults to this addon's index

Returns

  • NoirVehicle

Noir.Services.VehicleService:GetVehicle(ID)

Get a vehicle from the vehicle service.

Parameters

  • ID: integer

Returns

  • NoirVehicle|nil

Noir.Services.VehicleService:GetBody(ID)

Get a body from the vehicle service.

Parameters

  • ID: integer

Returns

  • NoirBody|nil

Noir.Services.VehicleService:GetVehicles()

Get all spawned vehicles.

Returns

  • table<integer, NoirVehicle>

Noir.Services.VehicleService:GetBodies()

Get all spawned bodies.

Returns

  • table<integer, NoirBody>

Noir.Services.VehicleService:GetBodiesFromPlayer(player)

Get all bodies spawned by a player.

Parameters

  • player: NoirPlayer

Returns

  • table<integer, NoirBody>

Noir.Services.VehicleService:GetVehiclesFromPlayer(player)

Get all vehicles spawned by a player.

Parameters

  • player: NoirPlayer

Returns

  • table<integer, NoirVehicle>

PreviousUIServiceNextCallbacks

Last updated 2 months ago

☄️