A damage movement which plays an animation and nothing else. More...

Inheritance diagram for PlatformerPro.DamageMovement_AnimationOnly:

Public Member Functions
override void	DoMove ()
	Moves the character. More...

override Movement	Init (Character character, MovementVariable[] movementData)
	Initialise the mvoement with the given movement data. More...

override bool	ForceMaintainControl ()
	If the jump just started force control. More...

override 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...

Public Attributes
float	animationLength
	How long the animation should be played for. More...

bool	applyGravity
	Should we still apply gravity and base collisions? More...

Protected Attributes
float	animationTimer
	The animation timer. Counts down for how long we should hold the state. More...

Protected Attributes inherited from PlatformerPro.DamageMovement
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...

Static Protected Attributes
const int	MovementVariableCount = 2
	The size of the movement variable array. 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 AnimationState	AnimationState `[get]`
	Gets the animation state that this movement wants to set. More...

Properties inherited from PlatformerPro.DamageMovement
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 damage movement which plays an animation and nothing else.

Member Function Documentation

◆ Damage()

override void PlatformerPro.DamageMovement_AnimationOnly.Damage	(	DamageInfo	info,
		bool	isDeath
	)

virtual

Start the damage movement.

Parameters

info Info.

Reimplemented from PlatformerPro.DamageMovement.

◆ DoMove()

override void PlatformerPro.DamageMovement_AnimationOnly.DoMove ( )

Moves the character.

◆ ForceMaintainControl()

override bool PlatformerPro.DamageMovement_AnimationOnly.ForceMaintainControl ( )

If the jump just started force control.

◆ Init()

override Movement PlatformerPro.DamageMovement_AnimationOnly.Init	(	Character	character,
		MovementVariable[]	movementData
	)

Initialise the mvoement with the given movement data.

Parameters

character	Character.
movementData	Movement data.

Member Data Documentation

◆ animationLength

float PlatformerPro.DamageMovement_AnimationOnly.animationLength

How long the animation should be played for.

◆ animationTimer

float PlatformerPro.DamageMovement_AnimationOnly.animationTimer

protected

The animation timer. Counts down for how long we should hold the state.

◆ applyGravity

bool PlatformerPro.DamageMovement_AnimationOnly.applyGravity

Should we still apply gravity and base collisions?

◆ MovementVariableCount

const int PlatformerPro.DamageMovement_AnimationOnly.MovementVariableCount = 2

staticprotected

The size of the movement variable array.

Property Documentation

◆ AnimationState

override AnimationState PlatformerPro.DamageMovement_AnimationOnly.AnimationState

get

Gets the animation state that this movement wants to set.

◆ Info

new static MovementInfo PlatformerPro.DamageMovement_AnimationOnly.Info

staticget

Static movement info used by the editor.

◆ ShouldApplyGravity

override bool PlatformerPro.DamageMovement_AnimationOnly.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_AnimationOnly.cs

Public Member Functions

Public Attributes

Protected Attributes

Static Protected Attributes

Properties