Click or drag to resize

WeatherMakerThunderAndLightningScript2D Class

2D lightning script
Inheritance Hierarchy
SystemObject
  Object
    Component
      Behaviour
        MonoBehaviour
          DigitalRuby.WeatherMakerWeatherMakerThunderAndLightningScript
            DigitalRuby.WeatherMakerWeatherMakerThunderAndLightningScript2D

Namespace:  DigitalRuby.WeatherMaker
Assembly:  Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
Syntax
public class WeatherMakerThunderAndLightningScript2D : WeatherMakerThunderAndLightningScript

The WeatherMakerThunderAndLightningScript2D type exposes the following members.

Constructors
  NameDescription
Public methodWeatherMakerThunderAndLightningScript2D
Initializes a new instance of the WeatherMakerThunderAndLightningScript2D class
Top
Properties
  NameDescription
Public propertyanimation Obsolete.

The Animation attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyaudio Obsolete.

The AudioSource attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyAudioSourceThunder
Thunder audio source
(Inherited from WeatherMakerThunderAndLightningScript.)
Public propertycamera Obsolete.

The Camera attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertycollider Obsolete.

The Collider attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertycollider2D Obsolete.

The Collider2D component attached to the object.

(Inherited from Component.)
Public propertyconstantForce Obsolete.

The ConstantForce attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyenabled

Enabled Behaviours are Updated, disabled Behaviours are not.

(Inherited from Behaviour.)
Public propertyEnableLightning
Toggle lightning enabled - set this last after changing all other properties
(Inherited from WeatherMakerThunderAndLightningScript.)
Public propertygameObject

The game object this component is attached to. A component is always attached to a game object.

(Inherited from Component.)
Public propertyguiElement Obsolete. (Inherited from Component.)
Public propertyguiText Obsolete.

The GUIText attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyguiTexture Obsolete.

The GUITexture attached to this GameObject (Read Only). (null if there is none attached).

(Inherited from Component.)
Public propertyhideFlags

Should the object be hidden, saved with the scene or modifiable by the user?

(Inherited from Object.)
Public propertyhingeJoint Obsolete.

The HingeJoint attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyisActiveAndEnabled

Has the Behaviour had enabled called.

(Inherited from Behaviour.)
Protected propertyLastThunderSound
Last sound played
(Inherited from WeatherMakerThunderAndLightningScript.)
Public propertylight Obsolete.

The Light attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyname

The name of the object.

(Inherited from Object.)
Public propertynetworkView Obsolete.

The NetworkView attached to this GameObject (Read Only). (null if there is none attached).

(Inherited from Component.)
Protected propertyNextLightningTime
Next strike time
(Inherited from WeatherMakerThunderAndLightningScript.)
Public propertyparticleEmitter Obsolete.

The ParticleEmitter attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyparticleSystem Obsolete.

The ParticleSystem attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrenderer Obsolete.

The Renderer attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrigidbody Obsolete.

The Rigidbody attached to this GameObject. (Null if there is none attached).

(Inherited from Component.)
Public propertyrigidbody2D Obsolete.

The Rigidbody2D that is attached to the Component's GameObject.

(Inherited from Component.)
Public propertyrunInEditMode

Allow a specific instance of a MonoBehaviour to run in edit mode (only available in the editor).

(Inherited from MonoBehaviour.)
Public propertytag

The tag of this game object.

(Inherited from Component.)
Public propertytransform

The Transform attached to this GameObject.

(Inherited from Component.)
Public propertyuseGUILayout

Disabling this lets you skip the GUI layout phase.

(Inherited from MonoBehaviour.)
Top
Methods
  NameDescription
Public methodBroadcastMessage(String)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Public methodBroadcastMessage(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object or any of its children.

(Inherited from Component.)
Protected methodCalculateEndPosition
Compute end position
(Overrides WeatherMakerThunderAndLightningScriptCalculateEndPosition(Vector3, Vector3, Camera, Boolean).)
Protected methodCalculateStartPosition
Compute start position
(Overrides WeatherMakerThunderAndLightningScriptCalculateStartPosition(Vector3, Camera, Boolean, Boolean).)
Public methodCallIntenseLightning
Summon intense lightning
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodCallIntenseLightning(NullableVector3, NullableVector3)
Summon intense lightning
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodCallNormalLightning
Summon normal lightning
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodCallNormalLightning(NullableVector3, NullableVector3)
Summon normal lightning
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodCancelInvoke

Cancels all Invoke calls on this MonoBehaviour.

(Inherited from MonoBehaviour.)
Public methodCancelInvoke(String)

Cancels all Invoke calls with name methodName on this behaviour.

(Inherited from MonoBehaviour.)
Public methodCompareTag

Is this game object tagged with tag ?

(Inherited from Component.)
Public methodEquals (Inherited from Object.)
Protected methodFinalize (Inherited from Object.)
Public methodGetComponent(Type)

Returns the component of Type type if the game object has one attached, null if it doesn't.

(Inherited from Component.)
Public methodGetComponent(String)

Returns the component with name type if the game object has one attached, null if it doesn't.

(Inherited from Component.)
Public methodGetComponent``1 (Inherited from Component.)
Public methodGetComponentInChildren(Type)

Returns the component of Type type in the GameObject or any of its children using depth first search.

(Inherited from Component.)
Public methodGetComponentInChildren(Type, Boolean) (Inherited from Component.)
Public methodGetComponentInChildren``1 (Inherited from Component.)
Public methodGetComponentInChildren``1(Boolean) (Inherited from Component.)
Public methodGetComponentInParent(Type)

Returns the component of Type type in the GameObject or any of its parents.

(Inherited from Component.)
Public methodGetComponentInParent``1 (Inherited from Component.)
Public methodGetComponents(Type)

Returns all components of Type type in the GameObject.

(Inherited from Component.)
Public methodGetComponents(Type, ListComponent) (Inherited from Component.)
Public methodGetComponents``1 (Inherited from Component.)
Public methodGetComponents``1(ListUMP) (Inherited from Component.)
Public methodGetComponentsInChildren(Type)

Returns all components of Type type in the GameObject or any of its children.

(Inherited from Component.)
Public methodGetComponentsInChildren(Type, Boolean)

Returns all components of Type type in the GameObject or any of its children.

(Inherited from Component.)
Public methodGetComponentsInChildren``1 (Inherited from Component.)
Public methodGetComponentsInChildren``1(Boolean) (Inherited from Component.)
Public methodGetComponentsInChildren``1(ListUMP) (Inherited from Component.)
Public methodGetComponentsInChildren``1(Boolean, ListUMP) (Inherited from Component.)
Public methodGetComponentsInParent(Type) (Inherited from Component.)
Public methodGetComponentsInParent(Type, Boolean)

Returns all components of Type type in the GameObject or any of its parents.

(Inherited from Component.)
Public methodGetComponentsInParent``1 (Inherited from Component.)
Public methodGetComponentsInParent``1(Boolean) (Inherited from Component.)
Public methodGetComponentsInParent``1(Boolean, ListUMP) (Inherited from Component.)
Public methodGetHashCode (Inherited from Object.)
Public methodGetInstanceID

Returns the instance id of the object.

(Inherited from Object.)
Public methodGetType (Inherited from Object.)
Public methodInvoke

Invokes the method methodName in time seconds.

(Inherited from MonoBehaviour.)
Public methodInvokeRepeating

Invokes the method methodName in time seconds, then repeatedly every repeatRate seconds.

(Inherited from MonoBehaviour.)
Public methodIsInvoking

Is any invoke pending on this MonoBehaviour?

(Inherited from MonoBehaviour.)
Public methodIsInvoking(String)

Is any invoke on methodName pending?

(Inherited from MonoBehaviour.)
Protected methodMemberwiseClone (Inherited from Object.)
Protected methodOnEnable
OnEnable
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodSendMessage(String)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessage(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object.

(Inherited from Component.)
Public methodSendMessageUpwards(String)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, Object)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Public methodSendMessageUpwards(String, Object, SendMessageOptions)

Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.

(Inherited from Component.)
Protected methodStart
Start
(Inherited from WeatherMakerThunderAndLightningScript.)
Public methodStartCoroutine(IEnumerator)

Starts a coroutine.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine(String)

Starts a coroutine named methodName.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine(String, Object)

Starts a coroutine named methodName.

(Inherited from MonoBehaviour.)
Public methodStartCoroutine_Auto Obsolete. (Inherited from MonoBehaviour.)
Public methodStopAllCoroutines

Stops all coroutines running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(String)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(IEnumerator)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodStopCoroutine(Coroutine)

Stops the first coroutine named methodName, or the coroutine stored in routine running on this behaviour.

(Inherited from MonoBehaviour.)
Public methodToString

Returns the name of the GameObject.

(Inherited from Object.)
Protected methodUpdate
Update
(Inherited from WeatherMakerThunderAndLightningScript.)
Top
Fields
  NameDescription
Public fieldCloudLightningChance
The chance lightning will simply be in the clouds with no visible bolt
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldEndXVariance
The variance of the end point in the x direction. Can be absolute or percentage depending on 2D or 3D mode.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldEndYVariance
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.)
Public fieldEndZVariance
The variance of the end point in the z direction. Can be absolute or percentage depending on 2D or 3D mode.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldExternalIntensityMultiplier
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.)
Public fieldGroundLightningChance
The chance that non-cloud lightning will hit the ground
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldLightningBoltScript
Lightning bolt script
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldLightningForcedVisibilityProbability
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.)
Public fieldLightningIntenseProbability
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.)
Public fieldLightningIntervalTimeRange
Random interval between strikes.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldStartXVariance
The variance of the end point in the x direction. Can be absolute or percentage depending on 2D or 3D mode.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldStartYBase
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.)
Public fieldStartYBaseCloudOnly
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.)
Public fieldStartYVariance
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.)
Public fieldStartZVariance
The variance of the end point in the z direction. Can be absolute or percentage depending on 2D or 3D mode.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldThunderSoundPlayed
Fires when a thunder sounds plays. Parameters are the audio clip and intensity.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldThunderSoundsIntense
Sounds to play for intense thunder. One will be chosen at random for each lightning strike.
(Inherited from WeatherMakerThunderAndLightningScript.)
Public fieldThunderSoundsNormal
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.)
Public fieldVolumeModifier
Volume modifier for thunder
(Inherited from WeatherMakerThunderAndLightningScript.)
Top
Extension Methods
  NameDescription
Public Extension MethodCachedName
Get cached name
(Defined by WeatherMakerObjectExtensions.)
Public Extension MethodSetCachedName
Put name in the cache
(Defined by WeatherMakerObjectExtensions.)
Top
See Also