Flares

Description

Flares are overlays that glow independent of the surrounding lighting.\ They allow signals to be seen from a larger distance.

Flares for assets & signsFlares for leversFlares for signalsFlares for complexsignals

"flares": [  // (1)!
    {
        "id": "ul", // (2)!
        "color": "165;32;25", // (3)!
        "rotation": 180, // (4)!
        "postRotation": 0, // (5)!
        "pitch": 0, // (6)!
        "offset": 0.019, // (7)!
        "scalingMultiplier": 1,  // (8)!
        "alwaysOn": true,  // (9)!
        "objPath": "testpack/trafficlight/trafficlight.obj", // (10)!
        "objPathIndex": 0, // (11)!
        "objGroups": [ // (12)!
            "sign" // (13)!
        ],
        "texture": "flare_texture.png",  // (14)!
        "scaleWithDistance": false // (15)!
    },{
        "id": "ml",
        "color": "229;189;1",
        "rotation": 180,
        "postRotation": 0,
        "pitch": 0,
        "offset": 0.019,
        "scalingMultiplier": 1,
        "alwaysOn": true,
        "objPath": "testpack/trafficlight/trafficlight.obj",
        "objPathIndex": 0,
        "objGroups": [
            "sign"
        ],
        "texture": "flare_texture.png",
        "scaleWithDistance": false
    }
]

1. The list of flares you want for you assets and signs.

   Optional field.

   Default value: []

2. The ID of the flare, used to determine how large the lamp has to be.

   Required field!

   Despite the name, it does not have to be unique.

   The mod will look for parts of your sign that start with the name of the id.
   Those should only be the glowing parts (lamp, etc.)

   

3. The color your flare should glow in.

   Optional field.

   Default value: 0xFFFFFF (255,255,255 / white)

   You can add your desired color in these formats:

   RGBHEX

   ,;:-

   {
       "color": "0,127,255"
   }
   

   {
       "color": "0;127;255"
   }
   

   {
       "color": "0:127:255"
   }
   

   {
       "color": "0-127-255"
   }
   

   #0x

   {
       "color": "#007fff"
   }
   

   {
       "color": "0x007fff"
   }
   

   

4. The default rotation of the flare.

   Required field!

   Most likely value: 0 or 180

5. The post rotation of the flare.

   Optional field.
   This rotation will be applied AFTER the translation (incl. offset).

   Slightly experimental.

   Default value: 0

6. The pitch of the flare. Should it point more up- or downards?

   Optional field.

   Default value: 0
   Should most likely be the default value.

7. The offset of the flare from the center of the groups found via the ID.

   Required field!

   Value will probably be in this range: 0.005 - 0.045

   

8. The scaling multiplier of the flare.
   Used to fix size issues with the flares.

   Optional field.

   Default value: 1

9. Should the flare always be on?

   Optional for assets & signs.
   Will be ignored as those block do not have different states.

   Should be true or false.

10. The corresponding objPath

    Optional field. Required if your sign uses multiple different OBJ files.

    Default value: First obj-path in your asset or sign under "base".

11. The index of the OBJ that should be used.

    Optional field. Required if you use the same OBJ more than once under "base".

    Default value: 0
    First element starts at 0.

12. The obj groups used to center the flare

    Optional field. Required if you use a signal with an irregular shape.

13. The obj group used to center the flare

    Optional field. Required if you use a signal with an irregular shape.

14. The texture for the flare.

    Optional field.

    Default value: default flare

    Your own texture could look like this:

    

    Default flare <<>> Custom flare example
    The background of the file should be transparent.
    We added a black background to make it visible in the documentation.

15. Should the flare scale larger with distance?

    Optional field.

    Default value: false

    Slightly experimental.