Projectile used in projectile (ranged) attacks. Note you don't have to use projectile class for projectiles. More...

Inheritance diagram for PlatformerPro.Projectile:

Public Member Functions
virtual void	Fire (int damageAmount, DamageType damageType, Vector2 direction, IMob character, float charge=1.0f)
	Call to start the projectile moving. More...

virtual void	Finish ()
	End the characters attack, for most projectiles you will ignore this, but it may be useful for some movement types. More...

virtual void	DestroyProjectile (bool isEnemyHit)
	Destroy projectile. 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
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 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
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...

Properties
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
System.EventHandler< EmptyEventArgs >	ProjectileFired
	Event for when a projectile is fired. Typically used for enabling effects. More...

System.EventHandler< DamageInfoEventArgs >	ProjectileDestroyed
	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. Note you don't have to use projectile class for projectiles.

Member Function Documentation

◆ CalculateDamageAmount()

virtual int PlatformerPro.Projectile.CalculateDamageAmount	(	int	damageAmount,
		float	charge
	)

protectedvirtual

Calculates the actual damage amount.

Returns: The damage amount.

Parameters

damageAmount	Damage amount from the attack.
charge	Charge time.

Reimplemented in PlatformerPro.ChargableProjectile.

◆ CalculateSpeed()

virtual float PlatformerPro.Projectile.CalculateSpeed ( float charge )

protectedvirtual

Calculates the actual speed.

Returns: The speed.

Parameters

charge Charge time.

Reimplemented in PlatformerPro.ChargableProjectile.

◆ DestroyProjectile()

virtual void PlatformerPro.Projectile.DestroyProjectile ( bool isEnemyHit )

virtual

Destroy projectile.

Reimplemented in PlatformerPro.GrapplingHookProjectile, and PlatformerPro.GrenadeProjectile.

◆ DoDestroy()

virtual IEnumerator PlatformerPro.Projectile.DoDestroy ( bool isEnemyHit )

protectedvirtual

Sends the destory event, then waits for detroy delay, then destroys GO.

◆ Finish()

virtual void PlatformerPro.Projectile.Finish ( )

virtual

End the characters attack, for most projectiles you will ignore this, but it may be useful for some movement types.

◆ Fire()

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

virtual

Call to start the projectile moving.

Parameters

damageAmount	Damage amount.
damageType	Damage type.
direction	Direction of fire
character	Character doing the firing.
charge	How charged is the attack. Ignored by default you need to use a projectile type like ChargedProjectile to utilise this.

Reimplemented in PlatformerPro.GrapplingHookProjectile, and PlatformerPro.GrenadeProjectile.

◆ Move()

virtual void PlatformerPro.Projectile.Move ( )

protectedvirtual

Move the projectile, override if you want custom movement.

◆ OnProjectileDestroyed()

virtual void PlatformerPro.Projectile.OnProjectileDestroyed ( DamageInfo info )

protectedvirtual

Raises the projectile destroyed event.

Parameters

info Info.

◆ OnProjectileFired()

virtual void PlatformerPro.Projectile.OnProjectileFired ( )

protectedvirtual

Raises the projectile fired event.

Parameters

info Info.

◆ Validate()

override void PlatformerPro.Projectile.Validate ( PlatformerProMonoBehaviour myTarget )

virtual

Override this method if you want to provide custom validation. The actual code should be surrounded by the if UNITY_EDITOR / endif directive.

Reimplemented from PlatformerPro.PlatformerProMonoBehaviour.

Member Data Documentation

◆ actualSpeed

float PlatformerPro.Projectile.actualSpeed

protected

The actual speed.

◆ autoExplodeDelay

float PlatformerPro.Projectile.autoExplodeDelay

How long after projectile fires should we wait before automatically exploding it. 0 Means it wont explodes until it hits something.

isho

◆ damageInfo

DamageInfo PlatformerPro.Projectile.damageInfo

protected

Damage this projectile will cause.

◆ destroyDelay

float PlatformerPro.Projectile.destroyDelay

How long after projectile collides should we wait before destroying it.

◆ destroyOnEnemyHit

bool PlatformerPro.Projectile.destroyOnEnemyHit

Should this object be destroyed when this object hits an enemy?

◆ destroyOnSceneryHit

bool PlatformerPro.Projectile.destroyOnSceneryHit

Should this object be destroyed when this object hits scenery?

◆ direction

Vector2 PlatformerPro.Projectile.direction

Movement direction.

◆ fired

bool PlatformerPro.Projectile.fired

protected

Have we been fired?

◆ myRigidbody

Rigidbody2D PlatformerPro.Projectile.myRigidbody

protected

Cached rigidbody. IF a non-kinematic rigidboy is attached we launch by setting velocity and do not move each frame.

◆ projectileHitBox

ProjectileHitBox PlatformerPro.Projectile.projectileHitBox

The hit box that causes damage to enemies.

◆ remainingLifetime

float PlatformerPro.Projectile.remainingLifetime

protected

How long before we destory this bullet.

◆ rotate

bool PlatformerPro.Projectile.rotate = true

Should the projectile be rotated to face the direction of travel.

◆ speed

float PlatformerPro.Projectile.speed

How fast the projectile moves.

◆ visibleComponents

GameObject PlatformerPro.Projectile.visibleComponents

If non-null then this GameObject will ne turned on when the projectile is fired. Used for syncing projectile visuals with animation events.

Property Documentation

◆ Charge

float PlatformerPro.Projectile.Charge

getprotected set

Gets the charge which can be used by effects, etc.

The charge.

◆ ChargeLevel

int PlatformerPro.Projectile.ChargeLevel

getprotected set

Gets the charge as an int which can be used by effects, etc.

The charge.

◆ Header

override string PlatformerPro.Projectile.Header

get

Event Documentation

◆ ProjectileDestroyed

System.EventHandler<DamageInfoEventArgs> PlatformerPro.Projectile.ProjectileDestroyed

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.

◆ ProjectileFired

System.EventHandler<EmptyEventArgs> PlatformerPro.Projectile.ProjectileFired

Event for when a projectile is fired. Typically used for enabling effects.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Attacks/Projectiles/Projectile.cs

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Properties

Events

Detailed Description

Member Function Documentation

◆ CalculateDamageAmount()

◆ CalculateSpeed()

◆ DestroyProjectile()

◆ DoDestroy()

◆ Finish()

◆ Fire()

◆ Move()

◆ OnProjectileDestroyed()

◆ OnProjectileFired()

◆ Validate()

Member Data Documentation

◆ actualSpeed

◆ autoExplodeDelay

◆ damageInfo

◆ destroyDelay

◆ destroyOnEnemyHit

◆ destroyOnSceneryHit

◆ direction

◆ fired

◆ myRigidbody

◆ projectileHitBox

◆ remainingLifetime

◆ rotate

◆ speed

◆ visibleComponents

Property Documentation

◆ Charge

◆ ChargeLevel

◆ Header

Event Documentation

◆ ProjectileDestroyed

◆ ProjectileFired