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

An enemy movement that bobbles on damage or death. More...

Inheritance diagram for PlatformerPro.EnemyMovement_Damaged_Bobble:
PlatformerPro.EnemyDeathMovement PlatformerPro.ICompletableMovement PlatformerPro.EnemyMovement PlatformerPro.PlatformerProMonoBehaviour

Public Member Functions

override EnemyMovement Init (Enemy enemy)
 Initialise this movement and return a reference to the ready to use movement. More...
 
override bool DoMove ()
 Moves the enemy. More...
 
override void HitCharacter (Character character, DamageInfo info)
 Called when the enemy hits the character. More...
 
override void DoDamage (DamageInfo info)
 Do the damaged movement More...
 
override void DoDeath (DamageInfo info)
 Do the death movement More...
 
- Public Member Functions inherited from PlatformerPro.EnemyMovement
virtual void GainingControl ()
 Called when this movement is gaining control. More...
 
virtual bool LosingControl ()
 Called when this movement is losing control. More...
 
virtual void SetDirection (Vector2 direction)
 Often a movement will need some kind of direction information such as where the cahracter is in relation to the enemy. Use this to set that information. Note there is no specific rule for what that information is, it could be anything. More...
 
virtual void SwitchDirection ()
 Called by the enemy to switch (x) direction of the movement. Note that not all movements need to support this, they may do nothing. More...
 
virtual bool CheckForEdge (int movementDirection)
 Uses the Enemies feet colliders to see if there is nothing below the enemy, and if so returns true. More...
 
- Public Member Functions inherited from PlatformerPro.PlatformerProMonoBehaviour
virtual 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

float bobbleHeight
 The character bobbles on death, how high should it bobble. More...
 
float destroyDelay
 On death the GameObject will be destroyed after this many seconds. More...
 
float gravity = -35
 The gravity to apply when bobbling More...
 

Protected Member Functions

IEnumerator DestroyAfterDelay ()
 Wait a while then destroy the enemy. More...
 

Protected Attributes

float initialBobbleVelocity
 Stores velocity that will be applied on death. More...
 
float originalHeight
 The enemies starting position (pre-bobble). More...
 
- Protected Attributes inherited from PlatformerPro.EnemyMovement
Enemy enemy
 Cached reference to the character. More...
 

Properties

new static MovementInfo Info [get]
 Static movement info used by the editor. More...
 
override AnimationState AnimationState [get]
 Gets the animation state that this movement wants to set. More...
 
- Properties inherited from PlatformerPro.EnemyDeathMovement
virtual DamageMovementType damageMovementType [get]
 What does this death movement respond to? More...
 
virtual bool ExtendInvulnerableTime [get]
 Allow damage movement to extend invulnerable time (e.g. if enemy is frozen). More...
 
- Properties inherited from PlatformerPro.EnemyMovement
virtual AnimationState AnimationState [get]
 Gets the animation state that this movement wants to set. More...
 
virtual string OverrideState [get]
 Gets the animation override state that this movement wants to set. More...
 
virtual int FacingDirection [get]
 Returns the direction the character is facing. 0 for none, 1 for right, -1 for left. More...
 
virtual bool ShouldSnapToGround [get]
 If we are grounded shoudl we snap to the ground. Helps us handle slopes. More...
 
static MovementInfo Info [get]
 Static movement info used by the editor. 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...
 

Detailed Description

An enemy movement that bobbles on damage or death.

Member Function Documentation

◆ DestroyAfterDelay()

IEnumerator PlatformerPro.EnemyMovement_Damaged_Bobble.DestroyAfterDelay ( )
protected

Wait a while then destroy the enemy.

◆ DoDamage()

override void PlatformerPro.EnemyMovement_Damaged_Bobble.DoDamage ( DamageInfo  info)
virtual

Do the damaged movement

Reimplemented from PlatformerPro.EnemyMovement.

◆ DoDeath()

override void PlatformerPro.EnemyMovement_Damaged_Bobble.DoDeath ( DamageInfo  info)
virtual

Do the death movement

Reimplemented from PlatformerPro.EnemyMovement.

◆ DoMove()

override bool PlatformerPro.EnemyMovement_Damaged_Bobble.DoMove ( )
virtual

Moves the enemy.

Reimplemented from PlatformerPro.EnemyMovement.

◆ HitCharacter()

override void PlatformerPro.EnemyMovement_Damaged_Bobble.HitCharacter ( Character  character,
DamageInfo  info 
)
virtual

Called when the enemy hits the character.

Parameters
characterCharacter.
infoDamage info.

Reimplemented from PlatformerPro.EnemyMovement.

◆ Init()

override EnemyMovement PlatformerPro.EnemyMovement_Damaged_Bobble.Init ( Enemy  enemy)
virtual

Initialise this movement and return a reference to the ready to use movement.

Reimplemented from PlatformerPro.EnemyMovement.

Member Data Documentation

◆ bobbleHeight

float PlatformerPro.EnemyMovement_Damaged_Bobble.bobbleHeight

The character bobbles on death, how high should it bobble.

◆ destroyDelay

float PlatformerPro.EnemyMovement_Damaged_Bobble.destroyDelay

On death the GameObject will be destroyed after this many seconds.

◆ gravity

float PlatformerPro.EnemyMovement_Damaged_Bobble.gravity = -35

The gravity to apply when bobbling

◆ initialBobbleVelocity

float PlatformerPro.EnemyMovement_Damaged_Bobble.initialBobbleVelocity
protected

Stores velocity that will be applied on death.

◆ originalHeight

float PlatformerPro.EnemyMovement_Damaged_Bobble.originalHeight
protected

The enemies starting position (pre-bobble).

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.EnemyMovement_Damaged_Bobble.AnimationState
get

Gets the animation state that this movement wants to set.

◆ Info

new static MovementInfo PlatformerPro.EnemyMovement_Damaged_Bobble.Info
staticget

Static movement info used by the editor.


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