# Lamp Settings The majority of light authoring in X-Plane is made through its large library of named and parameterized lights. These **"known"** Laminar Research lights come with an assortment of colors, directionality, and tie-ins with datarefs and airplane electrical systems to fit most artistic visions. Fully customizable lights are also available for your artist and complex plugin needs. These "known" lights are listed in a file called "lights.txt", located in your X-Plane installation folder. A copy is also included in the addon folder "io\_xplane2blender/resources/lights.txt". See the section **About lights.txt** for more about using this file. ## Relevant Blender Settings ### Lamp Type `Type` - XPlane2Blender uses this to tell if the artist wants a "Point" or non-"Point" (such as a "Spot") light. "Point" lights have no meaningful direction and are therefore used for things like car headlights and blinking runway lights. They're more optimizable than non-"Point" spotlights. A "Spot" type has a meaningful direction to it and are good for representing things like spotlights. Further mentions of `Type` will refer to XPlane2Blender's setting unless otherwise noted. `Color` - Custom Lights and old style lights use this for their RGB value ## XPlane2Blender Settings ### X-Plane Light Types X-Plane's light `Type` refers to what type of information is required to use them. * "Named" - Named lights use a specified pre-made light in X-Plane. They're the most common kind of light authors use * "Param" - Param lights are like named lights, but also allow partial customization of their behavior such as color, direction, or brightness * "Custom" - Custom lights are a textured billboards that use a size, a subsection of the OBJ texture, and, optionally, a dataref to control the look of them "Default (deprecated)", "Flashing (deprecated)", "Pulsing (deprecated)", "Strobe (deprecated)", and "Traffic (deprecated)" are old X-Plane 7 lights, now deprecated. #### Further Reading Developer Blog Articles * [Airplane Parameterized Light Guide](https://developer.x-plane.com/?article=airplane-parameterized-light-guide) * [Billboard and Spill Lights for OBJS](https://developer.x-plane.com/?article=billboard-and-spill-lights-for-objs) * [Custom Lights](https://developer.x-plane.com/?article=custom-lights) OBJ8 Spec Sections * [GEOMETRY\_COMMANDS](https://developer.x-plane.com/?article=obj8-file-format-specification#GEOMETRY_COMMANDS) Forum Posts * [Parsed contents of lights.txt](https://forums.x-plane.org/index.php?/forums/topic/133677-parsed-contents-of-lightstxt/) lights.txt Comment Sections * Lines 12-18, 38-62, 76-97 ### Common Settings | Setting | Default | Description | Requires | | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- | | `Type` | "Named" | The X-Plane light type, not to be confused with Blender's Lamp `Type`. See the above "X-Plane Light Types" section for more details | | | `Name` | "" | The name of the light. It should match a "known" Laminar Research light | `Type` must be "Named" or "Param" | | `Params` | "" | The numerical parameters for the parameterized light, separated by 1 or more spaces. Comments should start with a "#" or "//" | `Type` must be "Param" | #### Light Name Vs Named Light "Light Name" refers to the name of a pre-made light, such as "taxi\_b" or "airplane\_nav\_left\_size", see the setting `Name` above for more details. "Named Light" refers to the type of XPlane2Blender light which takes a light name and no parameters. ### Custom Light Settings | Setting | Default | Description | Requires | | --------------------- | ----------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | `Size` | 1.00 | The size of the custom light, the large the bigger. It isn't in meters or feet, it must be experimented with | `Type` must be "Custom" | | `Texture Coordinates` | (0.0,0.0,1.0,1.0) | An area of the OBJ's texture where the texture for the light is, specified as a fraction of the textures image between 0.0 and 1.0. The numbers represent the left, top, right, and bottom, respectively | `Type` must be "Custom" | | `Dataref` | "" | An optional dataref that will change the behavior of the light | `Type` must be "Custom" | | `Enable RGB Override` | Off | When enabled, RGB Override Values will be used instead of the Blender color picker. Useful for certain datarefs | `Type` must be "Custom" | | `RGB Override Values` | (0.0,0.0,0.0) | The values that will be used instead of the RGB picker | `Enable RGB Override` must be on | ## WYSIWYG Spot Lights Most spot lights can be aimed directly, without animation. Simply rotate the light and it will appear in X-Plane as so! The exporter will use the lamp's rotation, even if a param list includes X, Y, Z or DX, DY, DZ components. (The param list must still be valid.) This What-You-See-Is-What-You-Get behavior will be activated **if the Lamp is a "Spot" (or other non-"Point") lamp *****and***** a "Named" or "Param" type *****and***** the light name is included in the** `lights.txt` **file.** Lights that do not meet the above requirements can be aimed with the "Useless Keyframe" trick, found in [Aiming Special Non-WYSIWYG Lights](/xplane2blender-docs/index-3/34_indepth/aiming_special_non_wysiwyg_lights.md). **It is unnecessary in almost all cases.** ## About lights.txt lights.txt is essentially a massive table of information for X-Plane defining lights to be used in the sim. An artist only needs to be concerned with an extremely small portion of it. To read it, you'll need a good text editor (not Notepad or Word!) that can handle different line endings and has an adjustable tabstop (8 seems to work). Comments are prefixed with a #. It is located inside the addon folder, `io_xplane2blender\resources\lights.txt`. It can be replaced by the lights.txt file included in X-Plane. **Do not make changes to this file! Changes may be incompatible with X-Plane and may, at best, make your object export incorrectly or, at worst, crash X-Plane!** The vast majority of this file is not relevant and may be misleading. The most important column is the second one: the light name. Multiple lines with the same light name represent different light drawing styles X-Plane can choose from, not different lights with the same name. ### Anatomy of Param Lights 1. 1. 1. 4\. LIGHT\_PARAM\_DEF appron\_light\_billboard 5 X Y Z W S 2. "LIGHT\_PARAM\_DEF" declares that the following is a description of a parameterized light 3. The light name 4. The number of parameters, meaningless to an artist 5. The parameters for this param light which must be replaced by the artist Any light that doesn't have an associated LIGHT\_PARAM\_DEF is known simply as a "Named Light". ### Hints For Finding A Light's Use Though mostly undocumented, one can usually find the purpose of each light using some of these tips * Experiment! Make a scenery object with lots of lights and view it in X-Plane! * Light names are usually very descriptive * Comments nearby may explain their purpose * If a light name ends in "\_bb" it usually means it is meant to be used with a billboard light. Look for a corresponding "\_sp", such as "helipad\_flood\_bb" and "helipad\_flood\_sp" * If a light name ends in "\_sp" it usually means it's meant to be used as a pair with another light such as "taxi\_g" and "taxi\_g\_sp" or "radio\_const\_bb" and "radio\_const\_sp" * If it is a param light, the parameter names may be of help * Though the first column is meaningless in terms of artistic and authoring decisions, it could give clues as to it's use. For instance, if a light name only has BILLBOARD types associated with it, one can safely guess that the light will be a billboard. "SPILL\_HW\_FLA" lights such as "heli\_morse\_beacon" will **FLA**sh at an interval * If your file browser is sufficiently advanced, you can search for example uses of the light name in the text of existing .obj files in your X-Plane folder ### SPILL..., BILLBOARD..., and other first column prefixes The first column of each uncommented line of the light.txt is a defined light type. Each light name can have multiple types, and X-Plane will choose between them automatically. For instance, "taillight" includes 2 types for X-Plane to choose from: ``` BILLBOARD_HW taillight... SPILL_HW_DIR taillight... ``` **This information is only used by X-Plane and should not influence your decisions about whether to use Point or Spot lamps.** The differences between SPILL\_HW\_DR, SPILL\_SW, and etc have no impact on your work. For the overly curious, it is documented at the top of the file. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://xp2b-docs.gitbook.io/xplane2blender-docs/index-3/34_lamp_settings.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.