LightningBoltParameters Class

Constructor

Number of generations (0 for just a point light, otherwise 1 - 8). Higher generations have lightning with finer detail but more expensive to create.

A value between 0 and 0.999 that determines how fast the lightning should grow over the lifetime. A value of 1 grows slowest, 0 grows instantly

Points for the trunk to follow - not all generators support this

Used to generate random numbers. Not thread safe.

Override Random to a different Random. This gets set back to null when the parameters go back to the cache. Great for a one time bolt that looks a certain way.

Apply variance to a vector

Get a multiplier for fork distance

Get or create lightning bolt parameters. If cache has parameters, one is taken, otherwise a new object is created. NOT thread safe.

Reset parameters

Return parameters to cache. NOT thread safe.

How chaotic is the main trunk of lightning? (0 - 1). Higher numbers create more chaotic lightning.

How chaotic are the forks of the lightning? (0 - 1). Higher numbers create more chaotic lightning.

Tint color for the lightning, this is applied to both the lightning and the glow. Unlike the script properties for coloring which are applied per material, this is applied at the mesh level and as such different bolts on the same script can use different color values.

Custom transform action, null if none

Minimum delay

How long to wait in seconds before starting additional lightning bolts

End of the bolt

X, Y and Z radius variance from End

The ending width of a segment of lightning

Modify the fully lit time for FadePercent (0 - 1)

Modify the fade in time for FadePercent (0 - 1)

Modify the fade out time for FadePercent (0 - 1)

The percent of time the lightning should fade in and out (0 - 1). Example: 0.2 would fade in for 20% of the lifetime and fade out for 20% of the lifetime. Set to 0 for no fade.

How forked the lightning should be, 0 for none, 1 for LOTS of forks

Forks will have their end widths multiplied by this value

Minimum distance multiplier for forks

Variance of the fork distance (random range of 0 to n is added to ForkLengthMultiplier)

This is subtracted from the initial generations value, and any generation below that cannot have a fork

Generator to create the lightning bolt from the parameters

Intensity of the glow

Glow width multiplier

Intensity of the lightning

How long the bolt should live in seconds

Light parameters, null for none

Contains quality settings for different quality levels. By default, this assumes 6 quality levels, so if you have your own custom quality setting levels, you may want to clear this dictionary out and re-populate it with your own limits

Scale all scalar parameters by this value (i.e. trunk width, turbulence, turbulence velocity)

The amount of smoothing applied. For example, if there were 4 original points and smoothing / spline created 32 points, this value would be 8 - not all generators support this

Start of the bolt

X, Y and Z radius variance from Start

The width of the trunk