LightningFieldScript Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
DigitalRuby.ThunderAndLightningLightningBoltScript
DigitalRuby.ThunderAndLightningLightningBoltPrefabScriptBase
DigitalRuby.ThunderAndLightningLightningFieldScript
Namespace: DigitalRuby.ThunderAndLightning
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe LightningFieldScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LightningFieldScript | Initializes a new instance of the LightningFieldScript class |
Properties| Name | Description | |
|---|---|---|
 | animation | Obsolete. The Animation attached to this GameObject. (Null if there is none attached). |
| audio | Obsolete. The AudioSource attached to this GameObject. (Null if there is none attached). |
| camera | Obsolete. The Camera attached to this GameObject. (Null if there is none attached). |
| collider | Obsolete. The Collider attached to this GameObject. (Null if there is none attached). |
| collider2D | Obsolete. The Collider2D component attached to the object. |
| constantForce | Obsolete. The ConstantForce attached to this GameObject. (Null if there is none attached). |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| guiElement | Obsolete. (Inherited from Component.) |
| guiText | Obsolete. The GUIText attached to this GameObject. (Null if there is none attached). |
| guiTexture | Obsolete. The GUITexture attached to this GameObject (Read Only). (null if there is none attached). |
| HasActiveBolts |
Whether the script has active lightning bolts
(Inherited from LightningBoltScript.) |
| hideFlags | Should the object be hidden, saved with the scene or modifiable by the user? |
| hingeJoint | Obsolete. The HingeJoint attached to this GameObject. (Null if there is none attached). |
| isActiveAndEnabled | Has the Behaviour had enabled called. |
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| LightAddedCallback |
Fires when a light is added
(Inherited from LightningBoltScript.) |
| LightningEndedCallback |
Fires when lightning bolt is ended (trunk width, start, end)
(Inherited from LightningBoltScript.) |
| LightningStartedCallback |
Fires when lightning bolt is created (trunk width, start, end)
(Inherited from LightningBoltScript.) |
| LightRemovedCallback |
Fires when a light is removed
(Inherited from LightningBoltScript.) |
| name | The name of the object. |
| networkView | Obsolete. The NetworkView attached to this GameObject (Read Only). (null if there is none attached). |
| particleEmitter | Obsolete. The ParticleEmitter attached to this GameObject. (Null if there is none attached). |
| particleSystem | Obsolete. The ParticleSystem attached to this GameObject. (Null if there is none attached). |
| RandomOverride |
Override the random generator for the bolts
(Inherited from LightningBoltPrefabScriptBase.) |
| renderer | Obsolete. The Renderer attached to this GameObject. (Null if there is none attached). |
| rigidbody | Obsolete. The Rigidbody attached to this GameObject. (Null if there is none attached). |
| rigidbody2D | Obsolete. The Rigidbody2D that is attached to the Component's GameObject. |
| runInEditMode | Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor). |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
 | Awake |
AWake
(Inherited from LightningBoltScript.) |
| BroadcastMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| BroadcastMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CancelInvoke | Cancels all Invoke calls on this MonoBehaviour. |
| CancelInvoke(String) | Cancels all Invoke calls with name methodName on this behaviour. |
| CompareTag | Is this game object tagged with tag ? |
| CreateLightningBolt |
Create a lightning bolt
(Overrides LightningBoltPrefabScriptBaseCreateLightningBolt(LightningBoltParameters).) |
| CreateLightningBolts |
Create multiple lightning bolts, attempting to batch them into as few draw calls as possible
(Inherited from LightningBoltScript.) |
| CreateLightningBoltsNow |
Create lightning bolts immediately
(Inherited from LightningBoltPrefabScriptBase.) |
| CreateParameters |
Get or create lightning bolt parameters from cache, and set quality setting
(Inherited from LightningBoltScript.) |
| Equals | (Inherited from Object.) |
| Finalize | (Inherited from Object.) |
| GetComponent(Type) | Returns the component of Type type if the game object has one attached, null if it doesn't. |
| GetComponent(String) | Returns the component with name type if the game object has one attached, null if it doesn't. |
| GetComponent``1 | (Inherited from Component.) |
| GetComponentInChildren(Type) | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInChildren(Type, Boolean) | (Inherited from Component.) |
| GetComponentInChildren``1 | (Inherited from Component.) |
| GetComponentInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentInParent(Type) | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponentInParent``1 | (Inherited from Component.) |
| GetComponents(Type) | Returns all components of Type type in the GameObject. |
| GetComponents(Type, ListComponent) | (Inherited from Component.) |
| GetComponents``1 | (Inherited from Component.) |
| GetComponents``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren(Type) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren(Type, Boolean) | Returns all components of Type type in the GameObject or any of its children. |
| GetComponentsInChildren``1 | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean) | (Inherited from Component.) |
| GetComponentsInChildren``1(ListUMP) | (Inherited from Component.) |
| GetComponentsInChildren``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetComponentsInParent(Type) | (Inherited from Component.) |
| GetComponentsInParent(Type, Boolean) | Returns all components of Type type in the GameObject or any of its parents. |
| GetComponentsInParent``1 | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean) | (Inherited from Component.) |
| GetComponentsInParent``1(Boolean, ListUMP) | (Inherited from Component.) |
| GetHashCode | (Inherited from Object.) |
| GetInstanceID | Returns the instance id of the object. |
| GetType | (Inherited from Object.) |
| Invoke | Invokes the method methodName in time seconds. |
| InvokeRepeating | Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds. |
| IsInvoking | Is any invoke pending on this MonoBehaviour? |
| IsInvoking(String) | Is any invoke on methodName pending? |
| LateUpdate |
LateUpdate
(Inherited from LightningBoltScript.) |
| MemberwiseClone | (Inherited from Object.) |
| OnCreateParameters |
Get or create lightning bolt parameters from cache
(Inherited from LightningBoltScript.) |
| OnDrawGizmos |
OnDrawGizmos
(Inherited from LightningBoltPrefabScriptBase.) |
| PopulateParameters |
Populate lightning bolt parameters from script
(Inherited from LightningBoltPrefabScriptBase.) |
| SendMessage(String) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessage(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards(String) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| SendMessageUpwards(String, Object, SendMessageOptions) | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| Start |
Start
(Overrides LightningBoltPrefabScriptBaseStart.) |
| StartCoroutine(IEnumerator) | Starts a coroutine. |
| StartCoroutine(String) | Starts a coroutine named methodName. |
| StartCoroutine(String, Object) | Starts a coroutine named methodName. |
| StartCoroutine_Auto | Obsolete. (Inherited from MonoBehaviour.) |
| StopAllCoroutines | Stops all coroutines running on this behaviour. |
| StopCoroutine(String) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(IEnumerator) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| StopCoroutine(Coroutine) | Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour. |
| ToString | Returns the name of the GameObject. |
| Trigger |
Manually trigger the lightning once
(Inherited from LightningBoltPrefabScriptBase.) |
| Trigger(Single) |
Manually trigger lightning
(Inherited from LightningBoltPrefabScriptBase.) |
| Trigger(NullableVector3, NullableVector3) |
Manually trigger lightning
(Inherited from LightningBoltPrefabScriptBase.) |
| Update |
Update
(Overrides LightningBoltPrefabScriptBaseUpdate.) |
Fields| Name | Description | |
|---|---|---|
 | AutomaticModeSeconds | Turns lightning into automatic mode for this number of seconds, then puts it into manual mode. (Inherited from LightningBoltPrefabScriptBase.) |
| Camera | The camera the lightning should be shown in. Defaults to the current camera, or the main camera if current camera is null. If you are using a different camera, you may want to put the lightning in it's own layer and cull that layer out of any other cameras. (Inherited from LightningBoltScript.) |
| CameraMode | Type of camera mode. Auto detects the camera and creates appropriate lightning. Can be overriden to do something more specific regardless of camera. (Inherited from LightningBoltScript.) |
| ChaosFactor | The chaos factor that determines how far the lightning main trunk can spread out, higher numbers spread out more. 0 - 1. (Inherited from LightningBoltPrefabScriptBase.) |
| ChaosFactorForks | The chaos factor that determines how far the forks of the lightning can spread out, higher numbers spread out more. 0 - 1. (Inherited from LightningBoltPrefabScriptBase.) |
| CompensateForParentTransform | Whether to compensate for the parent transform. Default is false. If true, rotation, scale and position are altered by the parent transform. Use this to fix scaling, rotation and other offset problems with the lightning. (Inherited from LightningBoltScript.) |
| CountProbabilityModifier | Reduces the probability that additional bolts from CountRange will actually happen (0 - 1). (Inherited from LightningBoltPrefabScriptBase.) |
| CountRange | How many lightning bolts to emit for each interval (Inherited from LightningBoltPrefabScriptBase.) |
| CustomTransformHandler | Custom handler to modify the transform of each lightning bolt, useful if it will be alive longer than a few frames and needs to scale and rotate based on the position of other objects. (Inherited from LightningBoltPrefabScriptBase.) |
| DelayRange | Delay in seconds (range) before each additional lightning bolt in count range is emitted (Inherited from LightningBoltPrefabScriptBase.) |
| DestinationBlendMode | Destination blend mode. Default is One. For additive blend use One. For alpha blend use OneMinusSrcAlpha. (Inherited from LightningBoltScript.) |
| DurationRange | For each bolt emitted, how long should it stay in seconds (Inherited from LightningBoltPrefabScriptBase.) |
| EndWidthMultiplier | How much smaller the lightning should get as it goes towards the end of the bolt. For example, 0.5 will make the end 50% the width of the start. (Inherited from LightningBoltPrefabScriptBase.) |
| FadeFullyLitMultiplier | Modify the duration of fully lit lightning. (Inherited from LightningBoltPrefabScriptBase.) |
| FadeInMultiplier | Modify the duration of lightning fade in. (Inherited from LightningBoltPrefabScriptBase.) |
| FadeOutMultiplier | Modify the duration of lightning fade out. (Inherited from LightningBoltPrefabScriptBase.) |
| FadePercent | What percent of time the lightning should fade in and out. For example, 0.15 fades in 15% of the time and fades out 15% of the time, with full visibility 70% of the time. (Inherited from LightningBoltPrefabScriptBase.) |
| FieldBounds | The bounds to put the field in. |
| Forkedness | How forked should the lightning be? (0 - 1, 0 for none, 1 for lots of forks) (Inherited from LightningBoltPrefabScriptBase.) |
| ForkEndWidthMultiplier | Forks have their EndWidthMultiplier multiplied by this value (Inherited from LightningBoltPrefabScriptBase.) |
| ForkLengthMultiplier | Minimum distance multiplier for forks (Inherited from LightningBoltPrefabScriptBase.) |
| ForkLengthVariance | Fork distance multiplier variance. Random range of 0 to n that is added to Fork Length Multiplier. (Inherited from LightningBoltPrefabScriptBase.) |
| Generations | Generations (1 - 8, higher makes more detailed but more expensive lightning) (Inherited from LightningBoltPrefabScriptBase.) |
| GlowIntensity | The intensity of the glow (Inherited from LightningBoltPrefabScriptBase.) |
| GlowTintColor | Tint color for the lightning glow (Inherited from LightningBoltScript.) |
| GlowWidthMultiplier | The width multiplier for the glow, 0 - 64 (Inherited from LightningBoltPrefabScriptBase.) |
| GrowthMultiplier | 0 - 1, how slowly the lightning should grow. 0 for instant, 1 for slow. (Inherited from LightningBoltPrefabScriptBase.) |
| HideGizmos |
True to hide gizmos, false otherwise
(Inherited from LightningBoltScript.) |
| Intensity | Intensity of the lightning (Inherited from LightningBoltPrefabScriptBase.) |
| IntensityFlicker | Cause lightning to flicker, x = min, y = max, z = time multiplier, w = add to intensity (Inherited from LightningBoltScript.) |
| IntensityFlickerTexture | Lightning intensity flicker lookup texture (Inherited from LightningBoltScript.) |
| IntervalRange | Reduces the probability that additional bolts from CountRange will actually happen (0 - 1). (Inherited from LightningBoltPrefabScriptBase.) |
| JitterMultiplier | Jitter multiplier to randomize lightning size. Jitter depends on trunk width and will make the lightning move rapidly and jaggedly, giving a more lively and sometimes cartoony feel. Jitter may be shared with other bolts depending on materials. If you need different jitters for the same material, create a second script object. (Inherited from LightningBoltScript.) |
| LevelOfDetailDistance | If non-zero, the Camera property is used to get distance of lightning from camera. Lightning generations is reduced for each distance from camera. For example, if LevelOfDetailDistance was 100 and the lightning was 200 away from camera, generations would be reduced by 2, to a minimum of 1. (Inherited from LightningBoltScript.) |
| LifeTime | How long (in seconds) this game object should live before destroying itself. Leave as 0 for infinite. (Inherited from LightningBoltPrefabScriptBase.) |
| Light | Optional light for the lightning field to emit |
| LightningDestinationParticleSystem | Particle system to play at the point of impact (end). 'Emission rate' particles will be emitted all at once. (Inherited from LightningBoltScript.) |
| LightningGlowTexture | The texture to use for the lightning glow, or null for the material default texture. (Inherited from LightningBoltScript.) |
| LightningMaterialMesh | Lightning material for mesh renderer - glow (Inherited from LightningBoltScript.) |
| LightningMaterialMeshNoGlow | Lightning material for mesh renderer - bolt (Inherited from LightningBoltScript.) |
| LightningOriginParticleSystem | Particle system to play at the point of emission (start). 'Emission rate' particles will be emitted all at once. (Inherited from LightningBoltScript.) |
| LightningTexture | The texture to use for the lightning bolts, or null for the material default texture. (Inherited from LightningBoltScript.) |
| LightningTintColor | Tint color for the lightning (Inherited from LightningBoltScript.) |
| LightParameters | Light parameters (Inherited from LightningBoltPrefabScriptBase.) |
| ManualMode | Manual or automatic mode. Manual requires that you call the Trigger method in script. Automatic uses the interval to create lightning continuously. (Inherited from LightningBoltPrefabScriptBase.) |
| MaximumLightsPerBatch | Maximum number of lights that can be created per batch of lightning (Inherited from LightningBoltPrefabScriptBase.) |
| MinimumLength | The minimum length for a field segment |
| MultiThreaded | Whether to use multi-threaded generation of lightning. Lightning will be delayed by about 1 frame if this is turned on, but this can significantly improve performance. (Inherited from LightningBoltScript.) |
| QualitySetting | Lightning quality setting. This allows setting limits on generations, lights and shadow casting lights based on the global quality setting. (Inherited from LightningBoltScript.) |
| RenderQueue | The render queue for the lightning. -1 for default. (Inherited from LightningBoltScript.) |
| SoftParticlesFactor | Soft particles factor. 0.01 to 3.0 are typical, 100.0 to disable. (Inherited from LightningBoltScript.) |
| SortLayerName | Sort layer name (Inherited from LightningBoltScript.) |
| SortOrderInLayer | Order in sort layer (Inherited from LightningBoltScript.) |
| SourceBlendMode | Source blend mode. Default is SrcAlpha. (Inherited from LightningBoltScript.) |
| TrunkWidthRange | How long (in seconds) this game object should live before destroying itself. Leave as 0 for infinite. (Inherited from LightningBoltPrefabScriptBase.) |
| Turbulence | Built in turbulance based on the direction of each segment. Small values usually work better, like 0.2. (Inherited from LightningBoltScript.) |
| TurbulenceVelocity | Global turbulence velocity for this script (Inherited from LightningBoltScript.) |
| UseGameTime | True to use game time, false to use real time (Inherited from LightningBoltScript.) |
| UseWorldSpace | True if you are using world space coordinates for the lightning bolt, false if you are using coordinates relative to the parent game object. (Inherited from LightningBoltScript.) |
See Also