LightningBoltScript Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
DigitalRuby.ThunderAndLightningLightningBoltScript
DigitalRuby.ThunderAndLightningLightningBoltPrefabScriptBase
Namespace: DigitalRuby.ThunderAndLightning
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe LightningBoltScript type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LightningBoltScript | Initializes a new instance of the LightningBoltScript 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). |
 | DeltaTime |
Lightning delta time
|
| 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
|
| 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
|
| LightningEndedCallback |
Fires when lightning bolt is ended (trunk width, start, end)
|
| LightningStartedCallback |
Fires when lightning bolt is created (trunk width, start, end)
|
| LightRemovedCallback |
Fires when a light is removed
|
| 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). |
| 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. |
| TimeSinceStart |
Lightning time since script start
|
| TimeVectorSinceStart |
The last time value (see unity built in shader variables _Time)
|
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
 | Awake |
AWake
|
| 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
|
| CreateLightningBolts |
Create multiple lightning bolts, attempting to batch them into as few draw calls as possible
|
| CreateParameters |
Get or create lightning bolt parameters from cache, and set quality setting
|
| 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
|
| MemberwiseClone | (Inherited from Object.) |
| OnCreateParameters |
Get or create lightning bolt parameters from cache
|
| PopulateParameters |
Derived class can override to fill in lightning bolt parameters
|
| 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
|
| 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. |
| Update |
Update
|
Fields| Name | Description | |
|---|---|---|
 | 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. |
| CameraMode | Type of camera mode. Auto detects the camera and creates appropriate lightning. Can be overriden to do something more specific regardless of camera. |
| 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. |
| DestinationBlendMode | Destination blend mode. Default is One. For additive blend use One. For alpha blend use OneMinusSrcAlpha. |
| GlowTintColor | Tint color for the lightning glow |
| HideGizmos |
True to hide gizmos, false otherwise
|
| IntensityFlicker | Cause lightning to flicker, x = min, y = max, z = time multiplier, w = add to intensity |
| IntensityFlickerTexture | Lightning intensity flicker lookup texture |
| 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. |
| 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. |
| LightningDestinationParticleSystem | Particle system to play at the point of impact (end). 'Emission rate' particles will be emitted all at once. |
| LightningGlowTexture | The texture to use for the lightning glow, or null for the material default texture. |
| LightningMaterialMesh | Lightning material for mesh renderer - glow |
| LightningMaterialMeshNoGlow | Lightning material for mesh renderer - bolt |
| LightningOriginParticleSystem | Particle system to play at the point of emission (start). 'Emission rate' particles will be emitted all at once. |
| LightningTexture | The texture to use for the lightning bolts, or null for the material default texture. |
| LightningTintColor | Tint color for the lightning |
| 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. |
| QualitySetting | Lightning quality setting. This allows setting limits on generations, lights and shadow casting lights based on the global quality setting. |
| RenderQueue | The render queue for the lightning. -1 for default. |
| SoftParticlesFactor | Soft particles factor. 0.01 to 3.0 are typical, 100.0 to disable. |
| SortLayerName | Sort layer name |
| SortOrderInLayer | Order in sort layer |
| SourceBlendMode | Source blend mode. Default is SrcAlpha. |
| TimeScale |
Lightning time scale - as this approaches 0 time slows down
|
| Turbulence | Built in turbulance based on the direction of each segment. Small values usually work better, like 0.2. |
| TurbulenceVelocity | Global turbulence velocity for this script |
| UseGameTime | True to use game time, false to use real time |
| 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. |
See Also