# Light Objects (old)

## Light Properties

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-734b8a3c2242d3000dfb49cd7222bf287e956764%2Flight-object-properties-1.png?alt=media" alt=""><figcaption><p>Light Properties</p></figcaption></figure>

| Property Name                     | Description                                                                                    |
| --------------------------------- | ---------------------------------------------------------------------------------------------- |
| Type                              | Sets the light to be "Spot" (directional) or "Point" (omnidirectional).                        |
| Color                             | Changes the color of light source.                                                             |
| Brightness                        | How bright the light is.                                                                       |
| Outer Cone Angle (Only Spot Type) | Angle/Frustum of the outer spotlight cone. (Reference Image Light Source Outer-Inner Cone)     |
| Inner Cone Angle (Only Spot Type) | Angle/Frustum of the inner spotlight cone.                                                     |
| Source Size                       | Modifies the softness of the light source. (Reference Image Light Source Outer-Inner Cone)     |
| Light Range                       | Distance at which the light falls off.                                                         |
| Cast Static Shadows               | Enables shadows for static objects.                                                            |
| Cast Dynamic Shadows              | Enables shadows for dynamic objects, adds additional expense.                                  |
| Shadow Start Distance             | Distance from source at which the shadows start. (Reference Image Light Shadow Start Distance) |

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-878a138d4e8267dadc9ed7922fad5b9b3842a6c9%2Flight-cone-diagram.png?alt=media" alt=""><figcaption><p>Light Source Outer-Inner Cone</p></figcaption></figure>

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-d3783fb99258cffd0293aded650ab82e72288fdf%2Flight-cone-diagram-2.png?alt=media" alt=""><figcaption><p>Light Shadow Start Distance</p></figcaption></figure>

## Animation

{% hint style="info" %}
Animations are used to create Flickering lights
{% endhint %}

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-7a58fecba4f4c6521f32ba2710d252d46aa85db1%2Flight-animation-settings.png?alt=media" alt=""><figcaption><p>Animation Properties</p></figcaption></figure>

| Property Name | Description                                                     |
| ------------- | --------------------------------------------------------------- |
| Type          | Applies an animation to the light.                              |
| Rate          | Changes the Light animation Speed (Higher faster, lower slower) |

## Cone

{% hint style="info" %}
Light cones are versatile, cheap to render billboard objects. Used to create fake lighting effects, such as, light rays, fog, mist, smoke. Also used to create depth and pathing.
{% endhint %}

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-9816e211b557233d71655bffbb4d530b30f5ed3e%2Flight-cone-settings.png?alt=media" alt=""><figcaption><p>Cone Properties</p></figcaption></figure>

| Property Name       | Description                                                                                                                                                              |
| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Type                | The light cone attached to the object. (Reference Image Types of Light Cones)                                                                                            |
| Intensity           | How bright the light cone is.                                                                                                                                            |
| Length              | Changes the length of the light cone; Stacking multiple light cones over one another, or the larger the light cone takes up on screen, the more performance cost it has. |
| Width               | Changes the width of the light cone; Stacking multiple light cones over one another, or the larger the light cone takes up on screen, the more performance cost it has.  |
| Fade Start          | Distance from player when the light cone starts to fade.                                                                                                                 |
| Fade End            | Distance from player when the light come completely fades.                                                                                                               |
| Enable Parent Light | Toggles the light to be on/off; used when only a light cone is desired.                                                                                                  |

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-5c7c1e67e363d0eadbdae1c77fa34173e3fd8e50%2Flight-cones.png?alt=media" alt=""><figcaption><p>Types of Light Cones</p></figcaption></figure>

![Fade Start/End Example](https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-76c10cd7edb6a2e94626842be18cc80575abb88d%2Ffade-start-end.gif?alt=media)

![Enable Parent Light Example](https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-316a15e94b9f1439fa32382254145912f4f8d807%2Fenable-parent-light.gif?alt=media)

## Gobo

{% hint style="info" %}
Gobos are patterns projected from lights to give different lighting results. Examples being water caustics, faking shadows, or placing a Banished logo.
{% endhint %}

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-7fab396336bf2eb7800217d2631eb49638632b4e%2Fgobo-settings-none.png?alt=media" alt=""><figcaption><p>Gobo Properties</p></figcaption></figure>

| Property Name    | Description                                                                                                                                                                                           |
| ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Gobo Information | There can only be a limit of 4 Unique gobos rendering at the same time. Duplicates work fine, but 5+ gobos in close proximity still rendering will cause the gobos to flicker or not render correctly |
| Type             | Applies a stencil (pattern) projected from the light (Only works on "Spot" lights). (Reference Image Types of Gobos                                                                                   |

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-910d0cdeb7002fc8ffc666b5075eb19e125d76b0%2Ftypes-of-gobos.png?alt=media" alt=""><figcaption><p>Types of Gobos</p></figcaption></figure>

## OBB

{% hint style="info" %}
OBB's (Oriented Bounding Box) are used Primarily as a performance tool, clamping light pixels to have more performant heatmaps (Use the Light/Shadow Heatmaps to see light pixel influence)
{% endhint %}

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-096d220020aaa26f6c9017661826c900a431f81e%2Fobb-settings.png?alt=media" alt=""><figcaption><p>OBB Properties</p></figcaption></figure>

| Property Name          | Description                                                                    |
| ---------------------- | ------------------------------------------------------------------------------ |
| Enable OBB             | Toggles on/off OBB (Reference Images below )                                   |
| Scale with Light Range | Automatically scales the bounds if ""Light Range" changes                      |
| Lower X Bound          | Moves 1 side of the bounding box, setting can not be higher than Upper X Bound |
| Upper X Bound          | Moves 1 side of the bounding box, setting can not be higher than Lower X Bound |
| Lower Y Bound          | Moves 1 side of the bounding box, setting can not be higher than Upper Y Bound |
| Upper Y Bound          | Moves 1 side of the bounding box, setting can not be higher than Lower Y Bound |
| Bottom                 | Moves the Bottom of the Volume                                                 |
| Top                    | Moves the Bottom of the Volume                                                 |
| Show                   | Always render OBB Volume                                                       |

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-c01e069af6fc9b3ee9336a996877a698ce177ee9%2Fobb-adjusted.png?alt=media" alt=""><figcaption><p>OBB Adjusted</p></figcaption></figure>

<figure><img src="https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-c9b1a166cd150602bcd9228e6a56692f5d063133%2Fobb-default.png?alt=media" alt=""><figcaption><p>OBB Default</p></figcaption></figure>

![Debug On/Off](https://692276616-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FN06Vv6nlwviUQ4hI2Kkd%2Fuploads%2Fgit-blob-52d69d855e2a1e62b31e23d8e0b2efdddf37d564%2Fdebug-on-off.gif?alt=media)

#### Contributors

Nitro\
Tyler | Lighting Artist\
Captain Punch
