Skip to content

Asset: Vehicle

Aviril edited this page May 5, 2022 · 16 revisions

━ How to setup a vehicle?

  1. Create a folder with your desired asset name under files/assets/vehicle/.
  • Non Clumping:

    1. Asset's structure should be strictly as below attached:

      image

    2. Add your model named as asset.dff. [Note: File name matters here, it must strictly be asset.dff]

    3. Create a json file named as asset.json and configure based on your requirements as below attached: [Note: File name matters here, it must strictly be asset.json]

      image

  • Clumping:

    1. Asset's structure should be strictly as below attached:

      image

    2. Add your model's clumps under clump. [Note: File namings doesn't matter since they are referenced under asset.json]

    3. Create a json file named as asset.json and configure based on your requirements as below attached: [Note: File name matters here, it must strictly be asset.json]

    4. Add your clump names under assetClumps config as highlighted below.

      "assetClumps": {
          "yourClumpName1": "clumpFileName1",
          "yourClumpName2": "clumpFileName2",
          "yourClumpName3": "clumpFileName3"
      }

      image

  1. Create a txd file named as asset.txd and drop your necessary textures into it & save. [Note: File name matters here, it must strictly be asset.txd]

━ How to configure a vehicle?

  • assetBase: Default model whose properties vehicle element should inherit. [Default: 400]
  • assetTransparency: Boolean indicating whether vehicle element should have transparency property. [Default: false]
  • shaderMaps: Required if you prefer to use any built in Assetify shaders for your vehicle.

━ How to boot a vehicle?

  • Attach your vehicle name within files/assets/vehicle/manifest.json.
    [[
      "yourVehicleName1",
      "yourVehicleName2",
      "yourVehicleName3"
    ]]
  • Incase if you have enabled autoLoad under settings/shared.lua for vehicle assets then your vehicle shall be automatically loaded when you restart the library, either way you could use Assetify's APIs to dynamically load/unload them.
    assetify.loadAsset("vehicle", "yourVehicleName")
    assetify.unloadAsset("vehicle", "yourVehicleName")

━ How to use a vehicle?

  • Use below mentioned API to set/change your vehicle's element model.
  • Use the API server side if you prefer them to be synced.
    assetify.setElementAsset(yourVehicleElement, "yourAssetType", "yourAssetName", "yourClumpName", "yourClumpMaps")

Clone this wiki locally