RP Works Modding Docs
DocsStore
  • โฑ๏ธGetting Started
  • โ“Frequently Asked Questions
  • ๐ŸŒFiveM Resources
  • ๐ŸšจFiveM Lighting System [FLS]
  • ๐Ÿ“FLS Pattern Designer
  • โ˜๏ธDynamic Weather System
  • ๐Ÿ“นFree Camera Mode
  • ๐ŸฅŽHold and Throw
  • ๐ŸงจFlashbang
  • ๐Ÿš’BA Board
  • ๐Ÿ”ZoneCues [COMING SOON]
  • ๐Ÿง SceneAI [Coming Soon]
  • ๐Ÿ”‘Trakka Key Management [Coming Soon]
Powered by GitBook
On this page
  • How to Install
  • Adding a Vehicle
  • Configuring Lights
  • Configuring Patterns
  • Configuring Sirens
  • Configuring "999 Mode"
  • Configuring Wigwags
  • Showcase
  • โ“ Frequently Asked Questions

FiveM Lighting System [FLS]

The FiveM Lighting System is the descendant of our EmergencyLS, and acts as an all-in-one configurable vehicle lighting system for the popular Grand Theft Auto V (GTA V) Modification, FiveM.

PreviousFrequently Asked QuestionsNextFLS Pattern Designer

Last updated 2 months ago

How to Install

Follow instructions in

Adding a Vehicle

  1. Copy/Duplicate the existing example_1.10.json file into the 'Vehicles' folder

  2. Rename the file to match the 'gameName' value of the vehicle's meta file

  3. Now navigate to the config.lua file, and add the vehicle to the table, ensuring the text is surrounded by " and followed by a comma.

Configuring Lights

Lights in GTA V vehicles for ELS/FLS tend too use 'Extras' which can be toggled on/off depending on the pattern. So now we need to configure what colour, offset and direction each light points in.

Step 1: We need to tell the script how many extras there are in total

"extras": {
    "01": { -- 01 is the number for the extra
        -- Options/Configuration (Covered next)
    },
    "02": {
        -- Options/Configuration (Covered next)
    },
    -- And continue for as many as you need, ensuring there is a , afterwards...
}

Step 2: We now need to choose what colour we want the extra to be

"extras": {
    "01": { -- 01 is the number for the extra
        "Colour": "BLUE",
        -- Further options here...
    },
}

The options available, are: - BLUE - RED - AMBER - GREEN

Step 3: Next, we need to configure the offset for the light. Usually, lightbars work well with this set to 0.5 but it may be configured if the vehicle is taller/smaller

"extras": {
    "01": { -- 01 is the number for the extra
        "Colour": "BLUE",
        "offsetZ": 0.5,
        -- Further options here...
    },
}

The value MUST be a float (a decimal point number) greater than 0.0

Step 4: Finally, we need to configure the direction that the light emits for the directional lighting

"extras": {
    "01": { -- 01 is the number for the extra
        "Colour": "BLUE",
        "offsetZ": 0.5,
        "direction": "RIGHT FRONTRIGHT BACKRIGHT"
    },
}

The options available are:

  • FRONT

  • BACK

  • RIGHT

  • LEFT

  • FRONTRIGHT

  • BACKRIGHT

  • FRONTLEFT

  • BACKLEFT

As shown in the example codeblock, it's possible to include multiple values for a single light

Configuring Patterns

The pattern determines what lights turn on and when aswell as for how long. There are three different stages of lighting that we can configure, which is broken down into:

  1. Primary (Enabled with Q)

  2. Secondary (Enabled with L)

  3. Tertiary (Enabled with K)

The way to change the pattern of each is the exact same principle. Let's get started...

"pattern": {
    "primary": {
        "01": {
            "duration": "80",
            "extras": [
                "01",
                "02"
            ]
        },
        "02": {
            "duration": "80",
            "extras": [
                "03",
                "04"
            ]
        }
    }
}

Now, we'll break this down step by step. But first of all, this is essentially saying...

"When you turn on the primary lights, I want extras 1 and 2 to be on for 80ms and then turn off. Then, I want extras 3 and 4 to be on for 80ms and turn off after. Then, we'll loop back to the start and extras 1 and 2 will be back on for another 80ms again e.t.c."

"duration": "80", -- This is the length of time, in ms, that the extras stay on before moving onto the next flash
"extras": [
    "01", -- This is a list of extra numbers that will be switched on during this flash
    "02"
]

Configuring Sirens

Before configuring custom sirens, you must first install your chosen siren resource. We recommend WM-SIRENS

In the vehicle.json file under 'sirens', you can configure your custom siren packs to be used. These will all be server-sided and synced. Here's how the config looks...

"sirens": {
    "toneOne": {"AudioString":"SIREN_CHARLIE", "SoundSet": "DLC_WMSIRENS_SOUNDSET"},
    "toneTwo": {"AudioString":"SIREN_DELTA", "SoundSet": "DLC_WMSIRENS_SOUNDSET"},
    "toneThree": {"AudioString":"SIREN_GOLF", "SoundSet": "DLC_WMSIRENS_SOUNDSET"},
    "toneFour": {"AudioString":"SIREN_HOTEL", "SoundSet": "DLC_WMSIRENS_SOUNDSET"},
}

Here we can see we have 'toneOne' up to 'toneFour' - This corresponds to the 4 different siren tones available in-game, using the 1-4 keys or the 'next tone' keybind.

Let's break each one's configuration options down even more:

"toneOne": {
    "AudioString":"SIREN_CHARLIE", -- The siren's name
    "SoundSet":"DLC_WMSIRENS_SOUNDSET" -- The soundpack name 
},

Configuring "999 Mode"

999 mode refers to the added feature of a voice calling out "999 mode activated" in the vehicle once you activate the primary lighting. This is commonly found in UK ambulance fleets.

To enable this feature, simply set the following to true:

"999mode": true,

Configuring Wigwags

Wigwags refer to the alternation of the headlights on an emergency vehicle whilst the lighting system is activated, providing even further visibility.

To enable this feature, set the following to true:

"wigwag": true,

Showcase

โ“ Frequently Asked Questions

How optimised is this as opposed to others?

The resource reads as 1.32ms resource load with 50 vehicles in the player's vicinity, all with full lights and sirens activated simultaneously. This is a significant improvement on our competitor's resources.

Getting Started
๐Ÿšจ
Page cover image