2D Platform Controller  v1.7.0
Autogenerated code documentation for the 2D Platform Controller.
 All Classes Functions Variables Properties
FallDamage Class Reference

Add this to a character to enable the character to take fall damage. More...

Inherits MonoBehaviour.

Public Member Functions

void CharacterAnimationEvent (CharacterState state, CharacterState previousState)
 Respond to an animation event. We use this to track when the character is falling and when the character lands. More...
 

Public Attributes

RaycastCharacterController controller
 Character taking the damage. More...
 
float minSpeedForAction = -8.0f
 How fast we need to be falling before we take fall damage. More...
 
FallDamageAction fallDamageAction
 What action to take when a fall occurs. More...
 
float stunTime = 1.0f
 How long to stun the character after a fall. More...
 

Detailed Description

Add this to a character to enable the character to take fall damage.

Member Function Documentation

void FallDamage.CharacterAnimationEvent ( CharacterState  state,
CharacterState  previousState 
)

Respond to an animation event. We use this to track when the character is falling and when the character lands.

Parameters
stateState.
previousStatePrevious state.

Member Data Documentation

RaycastCharacterController FallDamage.controller

Character taking the damage.

FallDamageAction FallDamage.fallDamageAction

What action to take when a fall occurs.

float FallDamage.minSpeedForAction = -8.0f

How fast we need to be falling before we take fall damage.

float FallDamage.stunTime = 1.0f

How long to stun the character after a fall.


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