WeatherMakerThunderAndLightningScript2D Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
DigitalRuby.WeatherMakerWeatherMakerThunderAndLightningScript
DigitalRuby.WeatherMakerWeatherMakerThunderAndLightningScript2D
Namespace: DigitalRuby.WeatherMaker
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe WeatherMakerThunderAndLightningScript2D type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | WeatherMakerThunderAndLightningScript2D | Initializes a new instance of the WeatherMakerThunderAndLightningScript2D 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). |
| AudioSourceThunder |
Thunder audio source
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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. |
| EnableLightning |
Toggle lightning enabled - set this last after changing all other properties
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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). |
| 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. |
 | LastThunderSound |
Last sound played
(Inherited from WeatherMakerThunderAndLightningScript.) |
| light | Obsolete. The Light attached to this GameObject. (Null if there is none attached). |
| name | The name of the object. |
| networkView | Obsolete. The NetworkView attached to this GameObject (Read Only). (null if there is none attached). |
| NextLightningTime |
Next strike time
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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. |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
| 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. |
 | CalculateEndPosition |
Compute end position
(Overrides WeatherMakerThunderAndLightningScriptCalculateEndPosition(Vector3, Vector3, Camera, Boolean).) |
| CalculateStartPosition |
Compute start position
(Overrides WeatherMakerThunderAndLightningScriptCalculateStartPosition(Vector3, Camera, Boolean, Boolean).) |
| CallIntenseLightning |
Summon intense lightning
(Inherited from WeatherMakerThunderAndLightningScript.) |
| CallIntenseLightning(NullableVector3, NullableVector3) |
Summon intense lightning
(Inherited from WeatherMakerThunderAndLightningScript.) |
| CallNormalLightning |
Summon normal lightning
(Inherited from WeatherMakerThunderAndLightningScript.) |
| CallNormalLightning(NullableVector3, NullableVector3) |
Summon normal lightning
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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 ? |
| 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? |
| MemberwiseClone | (Inherited from Object.) |
| OnEnable |
OnEnable
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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
(Inherited from WeatherMakerThunderAndLightningScript.) |
| 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
(Inherited from WeatherMakerThunderAndLightningScript.) |
Fields| Name | Description | |
|---|---|---|
 | CloudLightningChance | The chance lightning will simply be in the clouds with no visible bolt (Inherited from WeatherMakerThunderAndLightningScript.) |
| EndXVariance | The variance of the end point in the x direction. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| EndYVariance | The variance of the end point in the y direction. Does not get applied if the lightning hit the ground. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| EndZVariance | The variance of the end point in the z direction. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| ExternalIntensityMultiplier | External intensity modifier to reduce amount of lightning. For example if a player moves indoors or in a cave, you could set this to 0 to turn off lightning. (Inherited from WeatherMakerThunderAndLightningScript.) |
| GroundLightningChance | The chance that non-cloud lightning will hit the ground (Inherited from WeatherMakerThunderAndLightningScript.) |
| LightningBoltScript | Lightning bolt script (Inherited from WeatherMakerThunderAndLightningScript.) |
| LightningForcedVisibilityProbability | Probability that lightning strikes will be forced to be visible in the camera view. Even if this fails, there is still a change that the lightning will be visible. Ignored for some modes such as 2D. (Inherited from WeatherMakerThunderAndLightningScript.) |
| LightningIntenseProbability | Probability (0-1) of an intense lightning bolt that hits really close. Intense lightning has increased brightness and louder thunder compared to normal lightning, and the thunder sounds plays a lot sooner. (Inherited from WeatherMakerThunderAndLightningScript.) |
| LightningIntervalTimeRange | Random interval between strikes. (Inherited from WeatherMakerThunderAndLightningScript.) |
| StartXVariance | The variance of the end point in the x direction. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| StartYBase | Starting y value for the lightning strikes. Can be absolute or percentage of visible scene height depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| StartYBaseCloudOnly | Starting y value for the cloud only lightning strikes. Can be absolute or percentage of visible scene height depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| StartYVariance | The variance of the end point in the y direction. Does not get applied if the lightning hit the ground. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| StartZVariance | The variance of the end point in the z direction. Can be absolute or percentage depending on 2D or 3D mode. (Inherited from WeatherMakerThunderAndLightningScript.) |
| ThunderSoundPlayed |
Fires when a thunder sounds plays. Parameters are the audio clip and intensity.
(Inherited from WeatherMakerThunderAndLightningScript.) |
| ThunderSoundsIntense | Sounds to play for intense thunder. One will be chosen at random for each lightning strike. (Inherited from WeatherMakerThunderAndLightningScript.) |
| ThunderSoundsNormal | Sounds to play for normal thunder. One will be chosen at random for each lightning strike. Depending on intensity, some normal lightning may not play a thunder sound. (Inherited from WeatherMakerThunderAndLightningScript.) |
| VolumeModifier | Volume modifier for thunder (Inherited from WeatherMakerThunderAndLightningScript.) |
Extension Methods| Name | Description | |
|---|---|---|
 | CachedName |
Get cached name
(Defined by WeatherMakerObjectExtensions.) |
| SetCachedName |
Put name in the cache
(Defined by WeatherMakerObjectExtensions.) |
See Also