Platformer Pro  2.3.2
A platform game kit for Unity.
PlatformerPro.GrenadeProjectile Class Reference

Projectile used in projectile (ranged) attacks that is controlled by physics. More...

Inheritance diagram for PlatformerPro.GrenadeProjectile:
PlatformerPro.Projectile PlatformerPro.PlatformerProMonoBehaviour

Public Member Functions

override void Fire (int damageAmount, DamageType damageType, Vector2 direction, IMob character, float charge=1.0f)
 Call to start the projectile moving. More...
 
override void DestroyProjectile (bool isEnemyHit)
 Destroy projectile. More...
 
- Public Member Functions inherited from PlatformerPro.Projectile
virtual void Finish ()
 End the characters attack, for most projectiles you will ignore this, but it may be useful for some movement types. More...
 
override void Validate (PlatformerProMonoBehaviour myTarget)
 Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive. More...
 

Public Attributes

GrenadeType grenadeTrigger
 How does the grenade work? More...
 
float triggerDelay = 0.0f
 How long is out timer (or how long after hitting something until we explode if type == EXPLODE_ON_HIT). More...
 
- Public Attributes inherited from PlatformerPro.Projectile
bool destroyOnEnemyHit
 Should this object be destroyed when this object hits an enemy? More...
 
bool destroyOnSceneryHit
 Should this object be destroyed when this object hits scenery? More...
 
float speed
 How fast the projectile moves. More...
 
ProjectileHitBox projectileHitBox
 The hit box that causes damage to enemies. More...
 
float autoExplodeDelay
 How long after projectile fires should we wait before automatically exploding it. 0 Means it wont explodes until it hits something. More...
 
float destroyDelay
 How long after projectile collides should we wait before destroying it. More...
 
bool rotate = true
 Should the projectile be rotated to face the direction of travel. More...
 
GameObject visibleComponents
 If non-null then this GameObject will ne turned on when the projectile is fired. Used for syncing projectile visuals with animation events. More...
 
Vector2 direction
 Movement direction. More...
 

Protected Member Functions

virtual IEnumerator DoTrigger ()
 Delays then sends event and enables hit box. More...
 
- Protected Member Functions inherited from PlatformerPro.Projectile
virtual void OnProjectileFired ()
 Raises the projectile fired event. More...
 
virtual void OnProjectileDestroyed (DamageInfo info)
 Raises the projectile destroyed event. More...
 
virtual void Move ()
 Move the projectile, override if you want custom movement. More...
 
virtual int CalculateDamageAmount (int damageAmount, float charge)
 Calculates the actual damage amount. More...
 
virtual float CalculateSpeed (float charge)
 Calculates the actual speed. More...
 
virtual IEnumerator DoDestroy (bool isEnemyHit)
 Sends the destory event, then waits for detroy delay, then destroys GO. More...
 

Protected Attributes

bool triggered
 Has greande triggered? More...
 
IMob character
 Character reference. More...
 
new Rigidbody2D rigidbody2D
 Reference to the rigidbody 2D. More...
 
- Protected Attributes inherited from PlatformerPro.Projectile
DamageInfo damageInfo
 Damage this projectile will cause. More...
 
bool fired
 Have we been fired? More...
 
float actualSpeed
 The actual speed. More...
 
float remainingLifetime
 How long before we destory this bullet. More...
 
Rigidbody2D myRigidbody
 Cached rigidbody. IF a non-kinematic rigidboy is attached we launch by setting velocity and do not move each frame. More...
 

Additional Inherited Members

- Properties inherited from PlatformerPro.Projectile
override string Header [get]
 
float Charge [get, protected set]
 Gets the charge which can be used by effects, etc. More...
 
int ChargeLevel [get, protected set]
 Gets the charge as an int which can be used by effects, etc. More...
 
- Properties inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual string Header [get]
 Gets the header string used to describe the component. More...
 
virtual string DocLink [get]
 Gets a link to documentation site. More...
 
virtual string VideoLink [get]
 Gets a link to a youtube video. More...
 
virtual string Deprecated [get]
 If non-null this component is deprecated. The string shows a message indicating how it should be replaced. More...
 
- Events inherited from PlatformerPro.Projectile
System.EventHandler< EmptyEventArgsProjectileFired
 Event for when a projectile is fired. Typically used for enabling effects. More...
 
System.EventHandler< DamageInfoEventArgsProjectileDestroyed
 Event for when a projectile crashes in to something. If the object being crashed in to is not an enemy then the damage info will be null. More...
 

Detailed Description

Projectile used in projectile (ranged) attacks that is controlled by physics.

Member Function Documentation

◆ DestroyProjectile()

override void PlatformerPro.GrenadeProjectile.DestroyProjectile ( bool  isEnemyHit)
virtual

Destroy projectile.

Reimplemented from PlatformerPro.Projectile.

◆ DoTrigger()

virtual IEnumerator PlatformerPro.GrenadeProjectile.DoTrigger ( )
protectedvirtual

Delays then sends event and enables hit box.

Returns
The trigger.

◆ Fire()

override void PlatformerPro.GrenadeProjectile.Fire ( int  damageAmount,
DamageType  damageType,
Vector2  direction,
IMob  character,
float  charge = 1.0f 
)
virtual

Call to start the projectile moving.

Parameters
damageAmountDamage amount.
damageTypeDamage type.
directionDirection of fire
characterCharacter doing the firing.
chargeHow charged is the attack. Ignored by grenades.

Reimplemented from PlatformerPro.Projectile.

Member Data Documentation

◆ character

IMob PlatformerPro.GrenadeProjectile.character
protected

Character reference.

◆ grenadeTrigger

GrenadeType PlatformerPro.GrenadeProjectile.grenadeTrigger

How does the grenade work?

◆ rigidbody2D

new Rigidbody2D PlatformerPro.GrenadeProjectile.rigidbody2D
protected

Reference to the rigidbody 2D.

◆ triggerDelay

float PlatformerPro.GrenadeProjectile.triggerDelay = 0.0f

How long is out timer (or how long after hitting something until we explode if type == EXPLODE_ON_HIT).

◆ triggered

bool PlatformerPro.GrenadeProjectile.triggered
protected

Has greande triggered?


The documentation for this class was generated from the following file: