A wrapper class for handling the characters movement (or lack thereof) when the character is dying. More...

Inheritance diagram for PlatformerPro.DamageMovement:

Public Member Functions
virtual void	Damage (DamageInfo info, bool isDeath)
	Start the damage movement. More...

Public Member Functions inherited from PlatformerPro.BaseMovement< DamageMovement >
sealed override Movement	Init (Character character)
	Initialise this movement. More...

bool	IsMovementDataDifferent (MovementVariable[] originalMovementData)
	Determines whether this instances movement data is different from the supplied originalMovementData. More...

Protected Attributes
DamageInfo	damageInfo
	Information about the damage sustained. More...

bool	isDeath
	Is this being used as a death movement. More...

Protected Attributes inherited from PlatformerPro.BaseMovement< DamageMovement >
Movement	implementation
	The class that will do the movement. More...

string	movementType
	The type of movement as a string. More...

MovementVariable[]	movementData
	Data that should be applied to the movement type on init. More...

Properties
new static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

override bool	ShouldApplyGravity `[get]`
	For damage the default is to not apply gravity. More...

override int	AnimationPriority `[get]`
	Gets the priority of the animation state that this movement wants to set. Death and damage need higher defaults. More...

Properties inherited from PlatformerPro.BaseMovement< DamageMovement >
virtual string	MovementType `[get, set]`
	The type of movement as a string. More...

virtual MovementVariable[]	MovementData `[get, set]`
	Data that should be applied to the movement type on init. More...

new static MovementInfo	Info `[get]`
	Static movement info used by the editor. More...

override bool	Enabled `[get, set]`
	A custom enable which base movements can use to pass on enable values. More...

override Movement	Implementation `[get]`
	Gets the underlying implementation. More...

Detailed Description

A wrapper class for handling the characters movement (or lack thereof) when the character is dying.

Member Function Documentation

◆ Damage()

virtual void PlatformerPro.DamageMovement.Damage	(	DamageInfo	info,
		bool	isDeath
	)

virtual

Start the damage movement.

Parameters

info	Info.
isDeath	Is the movement being used for death.

Reimplemented in PlatformerPro.DamageMovement_RandomAnimation, PlatformerPro.DamageMovement_ExplosiveForce, PlatformerPro.DamageMovement_AnimationWithBobble, PlatformerPro.DamageMovement_AnimationSyncPerDamageType, PlatformerPro.DamageMovement_AnimationPerDamageType, and PlatformerPro.DamageMovement_AnimationOnly.

Member Data Documentation

◆ damageInfo

DamageInfo PlatformerPro.DamageMovement.damageInfo

protected

Information about the damage sustained.

◆ isDeath

bool PlatformerPro.DamageMovement.isDeath

protected

Is this being used as a death movement.

Property Documentation

◆ AnimationPriority

override int PlatformerPro.DamageMovement.AnimationPriority

get

Gets the priority of the animation state that this movement wants to set. Death and damage need higher defaults.

◆ Info

new static MovementInfo PlatformerPro.DamageMovement.Info

staticget

Static movement info used by the editor.

◆ ShouldApplyGravity

override bool PlatformerPro.DamageMovement.ShouldApplyGravity

get

For damage the default is to not apply gravity.

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

D:/Projects/platformer-pro-2019.3/Assets/PlatformerPro/Scripts/Movement/Damage/DamageMovement.cs

Public Member Functions

Protected Attributes

Properties