mirror of
https://github.com/rojo-rbx/rojo.git
synced 2026-10-25 04:54:07 +00:00
update rules
This commit is contained in:
Joe
parent
4c390fdd37
commit
d5522b2fef
8549 changed files with 11783 additions and 1888 deletions
228
.cursor/rules/roblox/en-us/environment/lighting.md
Normal file
228
.cursor/rules/roblox/en-us/environment/lighting.md
Normal file
|
|
@ -0,0 +1,228 @@
|
|||
---
|
||||
title: Global lighting
|
||||
description: Explains how to customize the global lighting with the Lighting service.
|
||||
---
|
||||
|
||||
The `Class.Lighting` service contains properties that you can adjust to update
|
||||
and customize the global lighting in an experience. There are five categories of
|
||||
lighting properties:
|
||||
|
||||
- [Color](#color) — Configures hue within the experience.
|
||||
- [Intensity](#intensity) — Configures the intensity or amount of light hitting the camera.
|
||||
- [Shadows](#shadows) — Configures how a user experiences shadows within the experience.
|
||||
- [Appearance](#appearance) — Properties that determine the lighting style and lighting/shading quality or view distance prioritization.
|
||||
- [Environment](#environment) — Configures the conditions of the experience's world, such as the time of day and geographic latitude.
|
||||
|
||||
## Color
|
||||
|
||||
### Ambient
|
||||
|
||||
The `Class.Lighting.Ambient|Ambient` property sets a hue for the **entirety** of an experience. This property affects the lighting for both outdoor and indoor environments.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="[0, 0, 0]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Ambient-0-0-0.jpg" width="800" height="450" alt="Lighting.Ambient property of [0, 0, 0]" />
|
||||
</TabItem>
|
||||
<TabItem label="[160, 80, 0]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Ambient-160-80-0.jpg" width="800" height="450" alt="Lighting.Ambient property of [160, 80, 0]" />
|
||||
</TabItem>
|
||||
<TabItem label="[25, 0, 125]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Ambient-25-0-125.jpg" width="800" height="450" alt="Lighting.Ambient property of [25, 0, 125]" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### OutdoorAmbient
|
||||
|
||||
The `Class.Lighting.OutdoorAmbient|OutdoorAmbient`
|
||||
property sets a hue for **outdoor areas** of an experience. This can
|
||||
help simulate how the ambient color of real-life lighting changes
|
||||
throughout the day. For example, sunlight in the early morning or late
|
||||
afternoon is usually warmer and more pink and orange in tone, while late
|
||||
evening is usually cooler and more blue and purple in tone.
|
||||
|
||||
In the following images, note that the lighting inside the garage and cafe doesn't change like it would if you were changing the [Ambient](#ambient) property.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="[255, 150, 50]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/OutdoorAmbient-255-150-50.jpg" width="800" height="450" alt="Lighting.OutdoorAmbient property of [255, 150, 50]" />
|
||||
</TabItem>
|
||||
<TabItem label="[200, 150, 240]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/OutdoorAmbient-200-150-240.jpg" width="800" height="450" alt="Lighting.OutdoorAmbient property of [200, 150, 240]" />
|
||||
</TabItem>
|
||||
<TabItem label="[0, 175, 255]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/OutdoorAmbient-0-175-255.jpg" width="800" height="450" alt="Lighting.OutdoorAmbient property of [0, 175, 255]" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### ColorShift_Top
|
||||
|
||||
The `Class.Lighting.ColorShift_Top|ColorShift_Top` property sets a hue that reflects from surfaces facing the sun or moon.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="[0, 100, 255]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ColorShift-Top-0-100-255.jpg" width="800" height="450" alt="Lighting.ColorShift_Top property of [0, 100, 255]" />
|
||||
</TabItem>
|
||||
<TabItem label="[255, 60, 0]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ColorShift-Top-255-60-0.jpg" width="800" height="450" alt="Lighting.ColorShift_Top property of [255, 60, 0]" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### ColorShift_Bottom
|
||||
|
||||
The `Class.Lighting.ColorShift_Bottom|ColorShift_Bottom` property sets a hue that reflects from surfaces that are facing away from the sun or moon.
|
||||
|
||||
In the following images, note the hue change on the sandstone wall facing away from the sun.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="[255, 0, 220]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ColorShift-Bottom-255-0-220.jpg" width="800" height="450" alt="Lighting.ColorShift_Bottom property of [255, 0, 220]" />
|
||||
</TabItem>
|
||||
<TabItem label="[0, 255, 190]">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ColorShift-Bottom-0-255-190.jpg" width="800" height="450" alt="Lighting.ColorShift_Bottom property of [0, 255, 190]" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Intensity
|
||||
|
||||
### Brightness
|
||||
|
||||
The `Class.Lighting.Brightness|Brightness` property sets the intensity of illumination. This can help increase the contrast between brightly illuminated areas and shadows, simulating bright sunshine and warmer weather.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0.5">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Brightness-0.5.jpg" width="800" height="450" alt="Lighting.Brightness property of 0.5" />
|
||||
</TabItem>
|
||||
<TabItem label="1.5">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Brightness-1.5.jpg" width="800" height="450" alt="Lighting.Brightness property of 1.5" />
|
||||
</TabItem>
|
||||
<TabItem label="3.75">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/Brightness-3.75.jpg" width="800" height="450" alt="Lighting.Brightness property of 3.75" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### ExposureCompensation
|
||||
|
||||
The `Class.Lighting.ExposureCompensation|ExposureCompensation` property applies exposure to an experience. Exposure is the amount of light that reaches the camera.
|
||||
|
||||
A lower value is similar to under-exposure in photography, while a higher value is similar to over-exposure.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ExposureCompensation-0.jpg" width="800" height="450" alt="Lighting.ExposureCompensation property of 0" />
|
||||
</TabItem>
|
||||
<TabItem label="-1">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ExposureCompensation--1.jpg" width="800" height="450" alt="Lighting.ExposureCompensation property of -1" />
|
||||
</TabItem>
|
||||
<TabItem label="1.25">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ExposureCompensation-1.25.jpg" width="800" height="450" alt="Lighting.ExposureCompensation property of 1.25" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Shadows
|
||||
|
||||
### GlobalShadows
|
||||
|
||||
When enabled, the `Class.Lighting.GlobalShadows|GlobalShadows` property renders shadows.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Enabled">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/GlobalShadows-True.jpg" width="800" height="450" alt="Lighting.GlobalShadows property enabled" />
|
||||
</TabItem>
|
||||
<TabItem label="Disabled">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/GlobalShadows-False.jpg" width="800" height="450" alt="Lighting.GlobalShadows property disabled" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### ShadowSoftness
|
||||
|
||||
The `Class.Lighting.ShadowSoftness|ShadowSoftness` property adjusts how blurry shadows are from a value of `0` (hard edges) to `1` (soft edges). This property is only valid when `Class.Lighting.LightingStyle|LightingStyle` is set to `Enum.LightingStyle|Realistic`.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ShadowSoftness-0.jpg" width="800" height="450" alt="Lighting.ShadowSoftness property of 0" />
|
||||
</TabItem>
|
||||
<TabItem label="1">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/ShadowSoftness-1.jpg" width="800" height="450" alt="Lighting.ShadowSoftness property of 1" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
## Appearance
|
||||
|
||||
### LightingStyle
|
||||
|
||||
`Class.Lighting.LightingStyle|LightingStyle` indicates the artistic intent behind lighting in the experience, as an `Enum.LightingStyle` option. `Enum.LightingStyle|Realistic` provides the most advanced and realistic lighting and shadows Roblox can deliver, while `Enum.LightingStyle|Soft` produces a flat, retro‑Roblox look with softer lights and shadows.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="Realistic">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/LightingStyle-Realistic.jpg" width="800" height="450" alt="Lighting.LightingStyle setting of Realistic" />
|
||||
</TabItem>
|
||||
<TabItem label="Soft">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/LightingStyle-Soft.jpg" width="800" height="450" alt="Lighting.LightingStyle setting of Soft" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### PrioritizeLightingQuality
|
||||
|
||||
The `Class.Lighting.PrioritizeLightingQuality|PrioritizeLightingQuality` property indicates whether you prefer lighting/shading quality or view distance to scale down first. As the rendering quality level reduces, a setting of `true` prioritizes features such as advanced shadows and high‑quality shaders at closer distances, while a setting of `false` prioritizes view distance. If lighting and shadows are very important to the artistic feel of your experience, set this to `true`.
|
||||
|
||||
## Environment
|
||||
|
||||
### ClockTime and TimeOfDay
|
||||
|
||||
The `Class.Lighting.ClockTime|ClockTime` and `Class.Lighting.TimeOfDay|TimeOfDay` property both represent the current time of day in hours, and they are directly related; if you change one property, the other also changes.
|
||||
|
||||
The only difference between these properties is their numeric value; `Class.Lighting.ClockTime|ClockTime` represents time from hour `0` through `24` while
|
||||
`Class.Lighting.TimeOfDay|TimeOfDay` represents time through a 24 hour string.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0 = 00:00:00">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/TimeOfDay-0.jpg" width="800" height="450" alt="Lighting.ClockTime of 0 (TimeOfDay of 00:00:00)" />
|
||||
</TabItem>
|
||||
<TabItem label="6.3 = 06:18:00">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/TimeOfDay-6.3.jpg" width="800" height="450" alt="Lighting.ClockTime of 6.3 (TimeOfDay of 06:18:00)" />
|
||||
</TabItem>
|
||||
<TabItem label="17 = 17:00:00">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/TimeOfDay-17.jpg" width="800" height="450" alt="Lighting.ClockTime of 17 (TimeOfDay of 17:00:00)" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Alert severity="info">
|
||||
Note that each property doesn't follow the actual time of day, and they will not change during an experience unless changed through a script.
|
||||
</Alert>
|
||||
|
||||
### GeographicLatitude
|
||||
|
||||
The `Class.Lighting.GeographicLatitude|GeographicLatitude` property represents the geographic latitude in degrees. Note that while this property changes the position of the sun and moon, it does not change the `Class.Lighting.ClockTime|ClockTime` and `Class.Lighting.TimeOfDay|TimeOfDay` properties.
|
||||
|
||||
<video src="../assets/lighting-and-effects/lighting-properties/Geographic-Latitude.mp4" controls width="800" alt="Video showing GeographicLatitude property changing across 360 degrees"></video>
|
||||
|
||||
### EnvironmentDiffuseScale
|
||||
|
||||
The `Class.Lighting.EnvironmentDiffuseScale|EnvironmentDiffuseScale` property determines how much ambient light is derived from the environment.
|
||||
|
||||
In the following images, note how the ambient light changes, particularly inside the kitchen of the ramen shop.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/EnvironmentDiffuseScale-0.jpg" width="800" height="450" alt="Lighting.EnvironmentDiffuseScale property of 0" />
|
||||
</TabItem>
|
||||
<TabItem label="1">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/EnvironmentDiffuseScale-1.jpg" width="800" height="450" alt="Lighting.EnvironmentDiffuseScale property of 1" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
|
||||
### EnvironmentSpecularScale
|
||||
|
||||
The `Class.Lighting.EnvironmentSpecularScale|EnvironmentSpecularScale`
|
||||
property determines how much specular light is derived from the
|
||||
environment. When set near a value of 1, smooth objects better reflect
|
||||
the environment and metal appears more realistic.
|
||||
|
||||
<Tabs>
|
||||
<TabItem label="0">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/EnvironmentSpecularScale-0.jpg" width="800" height="450" alt="Lighting.EnvironmentSpecularScale property of 0" />
|
||||
</TabItem>
|
||||
<TabItem label="1">
|
||||
<img src="../assets/lighting-and-effects/lighting-properties/EnvironmentSpecularScale-1.jpg" width="800" height="450" alt="Lighting.EnvironmentSpecularScale property of 1" />
|
||||
</TabItem>
|
||||
</Tabs>
|
||||
Loading…
Add table
Add a link
Reference in a new issue