Skip to content

Commit 2f4868d

Browse files
Update index.md
1 parent f8aa13a commit 2f4868d

1 file changed

Lines changed: 43 additions & 26 deletions

File tree

docs/index.md

Lines changed: 43 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -60,8 +60,6 @@ The plugin includes a demo level showcasing multiple vertex lighting configurati
6060
### **VertexLighting_Manager**
6161
The `VertexLighting_Manager` is essential for vertex lighting functionality.
6262
<p style="color:#8A2BE2;"> <b>[📑IMPORTANT] Ensure only <ins>one</ins> manager is present per level.</b> </p>
63-
64-
<p style="color:#D2042D;"> <b>[‼️CAUTION] Only up to 256 vertex lights can be registered at the same time, without easy and simple modifications.</b> </p>
6563

6664
<img src="images/actor_icons/Light_Manager.avif" alt="The icon of the VertexLighting_Manager" width="200">
6765

@@ -86,7 +84,7 @@ The `VertexLighting_Manager` is essential for vertex lighting functionality.
8684
- *Default*: False | *Type*: Boolean
8785

8886
##### Ambient:
89-
- **Ambient Color**: Default environmental color.
87+
- **AmbientColor**: Default environmental color.
9088
- *Default*: Hex sRGB - 7C7C7CFF | *Type*: Linear Color
9189
- **SunNormalInfluence**: Controls how directional the vertex light sunlight should be, on a percentage basis. 0% makes the sunlight completely non-directional, while 100% makes it fully directional.
9290
- *Default*: 0% | *Type*: Float | *Range*: 0.0-100.0
@@ -98,15 +96,27 @@ The `VertexLighting_Manager` is essential for vertex lighting functionality.
9896
- *Default*: None | *Type*: Actor
9997

10098
##### Tickrate:
101-
- **Light Update Tickrate**: Time interval between light updates. Set to `0.0` to disable updates.
99+
- **TickrateLightUpdate**: Time interval between light updates. Set to `0.0` to disable updates.
102100
- *Default*: 0.1s | *Type*: Float | *Range*: 0.0-Infinite
101+
102+
##### Optimalization:
103+
- **MaximalLightDistanceOverride**: Overrides the maximum render distance for all the light. Set to `0.0` to disable override.
104+
- *Default*: 0.0cm | *Type*: Float | *Range*: 0.0-10000.0
105+
- **UnloadOutsideOfView**: This will make any lights unload when hopefully not on screen.
106+
- *Default*: False | *Type*: Boolean
107+
- **DisableTickingOffScreen**: This will make any lights stop ticking when not on screen. This may cause unintended light functioning.
108+
- *Default*: False | *Type*: Boolean
103109

104110
##### Debug:
105111
- **ShowCombinedVertexLightInfo**: Enables debug information about the active vertex lights.
106112
- *Default*: True | *Type*: Boolean
113+
- **ShowVertexLightsRenderedInfo**: Enables debug information about the amount of rendered vertex lights.
114+
- *Default*: True | *Type*: Boolean
107115
- **ShowCombinedVertexLightInfo**: Enables debug information about the exact day-night cycle time.
108116
- *Default*: True | *Type*: Boolean
109-
117+
118+
<p style="color:#D2042D;"> <b>[‼️CAUTION] This actor also contains variables in the Technical category. DO NOT CHANGE THESE VARIABLES UNLESS YOU KNOW WHAT YOU'RE DOING!</b> </p>
119+
110120
#### Sun Direction:
111121
The sun's direction is controlled by the rotation of the VertexLighting_Manager and is visually represented by a yellow arrow originating from the manager.
112122

@@ -125,25 +135,25 @@ The `VertexLighting_Light` adds a static or dynamic vertex light to your scene.
125135
<img src="images/actor_icons/Light.avif" alt="The icon of the VertexLighting_Light" width="200">
126136

127137
#### Default Settings:
128-
- **Light Color**: Color of the light.
138+
- **LightColor**: Color of the light.
129139
- *Default*: Hex sRGB - FFFFFFFF | *Type*: Linear Color
130140
<p style="color:#E1C16E;"> <b>[⚠️WARNING] Overridden by color curves for <i>VertexLighting_Light_Animated</i>.</b> </p>
131141
- **Brightness**: Light intensity.
132142
- *Default*: 10x | *Type*: Float | *Range*: 0.0-100.0
133143
<p style="color:#E1C16E;"> <b>[⚠️WARNING] Overridden by color curves for <i>VertexLighting_Light_Animated</i>.</b> </p>
134-
- **Influence Radius**: Radius of the light's influence.
144+
- **InfluenceRadius**: Radius of the light's influence.
135145
- *Default*: 300cm | *Type*: Float | *Range*: 0.0-Infinite
136-
- **Influence to Normal**: Controls how directional the vertex light should be, on a percentage basis. 0% makes the light completely non-directional, while 100% makes it fully directional.
146+
- **InfluencetoNormal**: Controls how directional the vertex light should be, on a percentage basis. 0% makes the light completely non-directional, while 100% makes it fully directional.
137147
- *Default*: 0% | *Type*: Float | *Range*: 0.0-100.0
138-
- **Render Distance**: Maximum render distance for the light.
148+
- **RenderDistance**: Maximum render distance for the light.
139149
- *Default*: 10,000cm | *Type*: Float | *Range*: 0.0-10,000.0
140-
- **Is Movable Light**: Makes the light's position dynamic during updates.
150+
- **IsMovable Light**: Makes the light's position dynamic during updates.
141151
- *Default*: False | *Type*: Boolean
142-
- **Should Turn On In Range**: Determines if the light activates when the player is nearby.
152+
- **ShouldTurnOnInRange**: Determines if the light activates when the player is nearby.
143153
- *Default*: True | *Type*: Boolean
144154

145155
#### Editor Settings:
146-
- **Show Render Distance**: Displays the render distance sphere in the editor.
156+
- **ShowRenderDistance**: Displays the render distance sphere in the editor.
147157
- *Default*: False | *Type*: Boolean
148158

149159
---
@@ -154,20 +164,30 @@ The `VertexLighting_Light_Animated` adds a static or dynamic vertex light with a
154164

155165
<img src="images/actor_icons/Light_Animated.avif" alt="The icon of the VertexLighting_Light_Animated" width="200">
156166

157-
#### Animated Light Settings:
158-
- **Color Curve**: Defines the color animation curve.
167+
#### Animated Light:
168+
- **ColorCurve**: Defines the color animation curve.
159169
- *Default*: "VertexLighting_ExampleColorCurve" | *Type*: Curve Linear Color
160-
- **Start Position**: Starting point of the color curve.
170+
- **StartPosition**: Starting point of the color curve.
161171
- *Default*: 0.0s | *Type*: Float
162-
- **Start at Random Position**: Starts the curve at a random timestamp.
172+
- **UseLightColorForPreview**: If true, the color used in the preview will use the 'LightColor' color. If false, it will use the starting 'StartPosition' on the 'ColorCurve' color even if it not a visible light color.
173+
- *Default*: true | *Type*: Boolean
174+
- **StartatRandom Position**: Starts the curve at a random timestamp.
163175
- *Default*: False | *Type*: Boolean
164-
- **Is Looping**: Determines if the animation repeats. If False, the light is destroyed after playback.
176+
- **IsLooping**: Determines if the animation repeats. If False, the light is destroyed after playback.
165177
- *Default*: True | *Type*: Boolean
166-
- **Play Rate**: Speed of the animation playback.
178+
- **PlayRate**: Speed of the animation playback.
167179
- *Default*: 100% | *Type*: Float
168-
- **Should Update No Tick Rate**: Forces updates for animated lights even when tick rate updates are disabled.
180+
- **CurveTickRate**: Time interval between Curve Light updates. Set to `0.0` to disable updates.
181+
- *Default*: 0.01s | *Type*: Float | *Range*: 0.0-Infinite
182+
- **ShouldUpdateNoTickRate**: Forces updates for animated lights even when tick rate updates are disabled.
169183
- *Default*: False | *Type*: Boolean
170184

185+
#### Animated Light Icon:
186+
- **IconColorTimeValue01**: This value gets used for the 2 colors that get used in the icon coloring.
187+
- *Default*: 0.5s | *Type*: Float | *Range*: Infinite
188+
- **IconColorTimeValue02**: This value gets used for the 2 colors that get used in the icon coloring.
189+
- *Default*: 1.5s | *Type*: Float | *Range*: Infinite
190+
171191
---
172192

173193
## Other Components
@@ -194,13 +214,10 @@ The `VertexLighting_Light_Animated` adds a static or dynamic vertex light with a
194214

195215
## Modifying maximum registered vertex lights
196216
To adjust the maximum number of vertex lights that can be registered at the same time:
197-
- Locate the 'VertexLightData_RenderTarget' render texture in the Content Browser.
198-
- Path: `VertexLightingPlugin/Content/Logic/TextureRenderTarget/VertexLightData_RenderTarget`
199-
- Open the texture file.
200-
- Find the 'Size X' setting.
201-
- This setting controls the maximum number of registered vertex lights.
202-
- The default value is 256. Adjust as needed.
203-
- Do not modify the 'Size Y' setting.
217+
- In-editor, go to **Edit -> Project Settings -> Plugins -> Vertex Lighting Plugin Settings**
218+
- Change the 'Max Lights' value to the number of your liking.
219+
220+
<p style="color:#D2042D;"> <b>[‼️CAUTION] There you can also change the render target that gets resized when you change the 'Max Lights' value. DO NOT CHANGE THIS VARIABLES UNLESS YOU KNOW WHAT YOU'RE DOING!</b> </p>
204221

205222
---
206223

0 commit comments

Comments
 (0)