You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index.md
+43-26Lines changed: 43 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -60,8 +60,6 @@ The plugin includes a demo level showcasing multiple vertex lighting configurati
60
60
### **VertexLighting_Manager**
61
61
The `VertexLighting_Manager` is essential for vertex lighting functionality.
62
62
<pstyle="color:#8A2BE2;"> <b>[📑IMPORTANT] Ensure only <ins>one</ins> manager is present per level.</b> </p>
63
-
64
-
<pstyle="color:#D2042D;"> <b>[‼️CAUTION] Only up to 256 vertex lights can be registered at the same time, without easy and simple modifications.</b> </p>
65
63
66
64
<imgsrc="images/actor_icons/Light_Manager.avif"alt="The icon of the VertexLighting_Manager"width="200">
67
65
@@ -86,7 +84,7 @@ The `VertexLighting_Manager` is essential for vertex lighting functionality.
86
84
-*Default*: False | *Type*: Boolean
87
85
88
86
##### Ambient:
89
-
-**Ambient Color**: Default environmental color.
87
+
-**AmbientColor**: Default environmental color.
90
88
-*Default*: Hex sRGB - 7C7C7CFF | *Type*: Linear Color
91
89
-**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.
-**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
103
109
104
110
##### Debug:
105
111
-**ShowCombinedVertexLightInfo**: Enables debug information about the active vertex lights.
106
112
-*Default*: True | *Type*: Boolean
113
+
-**ShowVertexLightsRenderedInfo**: Enables debug information about the amount of rendered vertex lights.
114
+
-*Default*: True | *Type*: Boolean
107
115
-**ShowCombinedVertexLightInfo**: Enables debug information about the exact day-night cycle time.
108
116
-*Default*: True | *Type*: Boolean
109
-
117
+
118
+
<pstyle="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
+
110
120
#### Sun Direction:
111
121
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.
112
122
@@ -125,25 +135,25 @@ The `VertexLighting_Light` adds a static or dynamic vertex light to your scene.
125
135
<imgsrc="images/actor_icons/Light.avif"alt="The icon of the VertexLighting_Light"width="200">
126
136
127
137
#### Default Settings:
128
-
-**Light Color**: Color of the light.
138
+
-**LightColor**: Color of the light.
129
139
-*Default*: Hex sRGB - FFFFFFFF | *Type*: Linear Color
130
140
<pstyle="color:#E1C16E;"> <b>[⚠️WARNING] Overridden by color curves for <i>VertexLighting_Light_Animated</i>.</b> </p>
-**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.
-**Is Movable Light**: Makes the light's position dynamic during updates.
150
+
-**IsMovable Light**: Makes the light's position dynamic during updates.
141
151
-*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.
143
153
-*Default*: True | *Type*: Boolean
144
154
145
155
#### Editor Settings:
146
-
-**Show Render Distance**: Displays the render distance sphere in the editor.
156
+
-**ShowRenderDistance**: Displays the render distance sphere in the editor.
147
157
-*Default*: False | *Type*: Boolean
148
158
149
159
---
@@ -154,20 +164,30 @@ The `VertexLighting_Light_Animated` adds a static or dynamic vertex light with a
154
164
155
165
<imgsrc="images/actor_icons/Light_Animated.avif"alt="The icon of the VertexLighting_Light_Animated"width="200">
156
166
157
-
#### Animated Light Settings:
158
-
-**Color Curve**: Defines the color animation curve.
167
+
#### Animated Light:
168
+
-**ColorCurve**: Defines the color animation curve.
159
169
-*Default*: "VertexLighting_ExampleColorCurve" | *Type*: Curve Linear Color
160
-
-**Start Position**: Starting point of the color curve.
170
+
-**StartPosition**: Starting point of the color curve.
161
171
-*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.
163
175
-*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.
165
177
-*Default*: True | *Type*: Boolean
166
-
-**Play Rate**: Speed of the animation playback.
178
+
-**PlayRate**: Speed of the animation playback.
167
179
-*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.
- 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
+
<pstyle="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>
0 commit comments