LightningWhipSpell Class |
Inheritance HierarchyObject
Component
Behaviour
MonoBehaviour
DigitalRuby.ThunderAndLightningLightningSpellScript
DigitalRuby.ThunderAndLightningLightningWhipSpell
Namespace: DigitalRuby.ThunderAndLightning
Assembly: Assembly-CSharp (in Assembly-CSharp.dll) Version: 0.0.0.0
SyntaxThe LightningWhipSpell type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | LightningWhipSpell | Initializes a new instance of the LightningWhipSpell 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). |
| CanCastSpell |
Determines whether the spell can be cast or not
(Inherited from LightningSpellScript.) |
| Casting |
Is the spell currently being cast?
(Inherited from LightningSpellScript.) |
| 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). |
 | CooldownTimer |
Cooldown, in seconds, remaining before spell can be cast again
(Inherited from LightningSpellScript.) |
| DurationTimer |
Duration, in seconds, remaining for the spell
(Inherited from LightningSpellScript.) |
| 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). |
| 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). |
| 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. |
| transform | The Transform attached to this GameObject. |
| useGUILayout | Disabling this lets you skip the GUI layout phase. |
Methods| Name | Description | |
|---|---|---|
| ActivateSpell |
Equip / ready the spell
(Inherited from LightningSpellScript.) |
 | ApplyCollisionForce |
Apply collision force at a point
(Inherited from LightningSpellScript.) |
| 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. |
| CastSpell |
Cast the spell
(Inherited from LightningSpellScript.) |
| CompareTag | Is this game object tagged with tag ? |
| DeactivateSpell |
Unequip the spell
(Inherited from LightningSpellScript.) |
| 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 |
Late Update.
(Inherited from LightningSpellScript.) |
| MemberwiseClone | (Inherited from Object.) |
| OnActivated |
Fires when spell is activated
(Overrides LightningSpellScriptOnActivated.) |
| OnCastSpell |
Fires when spell is cast
(Overrides LightningSpellScriptOnCastSpell.) |
| OnDeactivated |
Fires when spell is deactivated
(Overrides LightningSpellScriptOnDeactivated.) |
| OnDestroy |
On destroy - derived classes should call base class method first
(Inherited from LightningSpellScript.) |
| OnStopSpell |
Fires when spell is stopped
(Overrides LightningSpellScriptOnStopSpell.) |
| PlayCollisionSound |
Play a collision sound
(Inherited from LightningSpellScript.) |
| 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 LightningSpellScriptStart.) |
| 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.) |
| StopAfterSeconds |
Stop the spell after a certain amount of seconds. If the spell is stopped before seconds elapses, nothing happens.
(Inherited from LightningSpellScript.) |
| 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. |
| StopSpell |
Stop casting a spell. Some spells are single shot and this method does nothing. Spells
that are continouous for example would stop with this method call.
(Inherited from LightningSpellScript.) |
| ToString | Returns the name of the GameObject. |
| Update |
Update
(Overrides LightningSpellScriptUpdate.) |
Fields| Name | Description | |
|---|---|---|
 | AttachTo | Attach the whip to what object |
| CollisionAudioClips | Collision audio clips. One will be chosen at random and played one shot with CollisionAudioSource. (Inherited from LightningSpellScript.) |
| CollisionAudioSource | Collision audio source (Inherited from LightningSpellScript.) |
| CollisionCallback |
Callback for when the whip strikes a point
|
| CollisionForce | The force to explode with when there is a collision (Inherited from LightningSpellScript.) |
| CollisionForceMode | Collision force mode (Inherited from LightningSpellScript.) |
| CollisionIsExplosion | Whether the collision is an exploision. If not explosion, collision is directional. (Inherited from LightningSpellScript.) |
| CollisionMask | The layers that the spell should collide with (Inherited from LightningSpellScript.) |
| CollisionParticleSystem | The particle system for collisions. For best effects, this should emit particles in bursts at time 0 and not loop. (Inherited from LightningSpellScript.) |
| CollisionRadius | The radius of the collision explosion (Inherited from LightningSpellScript.) |
| CollisionVolumeRange | Collision sound volume range. (Inherited from LightningSpellScript.) |
| Cooldown | The cooldown in seconds. Once cast, the spell must wait for the cooldown before being cast again. (Inherited from LightningSpellScript.) |
| Direction | The direction of the spell. Should be normalized. Does not change unless explicitly modified. (Inherited from LightningSpellScript.) |
| Duration | The duration in seconds that the spell will last. Not all spells support a duration. For one shot spells, this is how long the spell cast / emission light, etc. will last. (Inherited from LightningSpellScript.) |
| EmissionLight | Light to illuminate when spell is cast (Inherited from LightningSpellScript.) |
| EmissionParticleSystem | Emission particle system. For best results use world space, turn off looping and play on awake. (Inherited from LightningSpellScript.) |
| EmissionSound | Emission sound (Inherited from LightningSpellScript.) |
| MaxDistance | The maximum distance of the spell (Inherited from LightningSpellScript.) |
| RotateWith | Rotate the whip with this object |
| SpellEnd | The end point of the spell. Set this to an empty game object. This will change depending on things like collisions, randomness, etc. Not all spells need an end object, but create this anyway to be sure. (Inherited from LightningSpellScript.) |
| SpellStart | The start point of the spell. Set this to a muzzle end or hand. (Inherited from LightningSpellScript.) |
| WhipCrackAudioSource | Whip crack audio source |
| WhipHandle | Whip handle |
| WhipSpring | Whip spring |
| WhipStart | Whip start |
See Also