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
  • Returns
  • Parameters
  • Parameters
  • Parameters
  • Returns
  • Parameters
  • Returns
  • Parameters
  • Parameters
Edit on GitHub
  1. API Reference
  2. Built-Ins
  3. Classes

Vehicle

Noir.Classes.Vehicle: NoirClass

Represents a vehicle.

In Stormworks, this is actually a vehicle group.


Noir.Classes.Vehicle:Init(ID, owner, spawnPosition, cost)

Initializes vehicle class objects.

Parameters

  • ID: any

  • owner: NoirPlayer|nil

  • spawnPosition: SWMatrix

  • cost: number


Noir.Classes.Vehicle:_Serialize()

Serialize the vehicle.

Used internally.

Returns

  • NoirSerializedVehicle


Noir.Classes.Vehicle:_Deserialize(serializedVehicle, addBodies)

Deserialize a serialized vehicle.

Parameters

  • serializedVehicle: NoirSerializedVehicle

  • addBodies: boolean|nil

Returns

  • NoirVehicle


Noir.Classes.Vehicle:_CalculatePrimaryBody()

Calculate the primary body.

Used internally.


Noir.Classes.Vehicle:_AddBody(body)

Add a body to the vehicle.

Used internally.

Parameters

  • body: NoirBody


Noir.Classes.Vehicle:_RemoveBody(body)

Remove a body from the vehicle.

Used internally.

Parameters

  • body: NoirBody


Noir.Classes.Vehicle:GetPosition(voxelX, voxelY, voxelZ)

Return this vehicle's position.

Uses the vehicle's primary body internally.

Parameters

  • voxelX: integer|nil

  • voxelY: integer|nil

  • voxelZ: integer|nil

Returns

  • SWMatrix


Noir.Classes.Vehicle:GetBody(ID)

Get a child body by its ID.

Parameters

  • ID: integer

Returns

  • NoirBody|nil


Noir.Classes.Vehicle:Teleport(position)

Teleport the vehicle to a new position.

Parameters

  • position: SWMatrix


Noir.Classes.Vehicle:Move(position)

Move the vehicle to a new position, essentially teleports without reloading the vehicle.

Note that rotation is ignored.

Parameters

  • position: SWMatrix


Noir.Classes.Vehicle:Despawn()

Despawn the vehicle.

PreviousTrackerNextWidgets

Last updated 2 months ago

β˜„οΈ