diguyMotionSpeedType.h File Reference

#include <declspec_diguy.h>

Go to the source code of this file.

Macros
#define	CPLUSPLUS_ONLY

Typedefs
typedef int	diguyMotionSpeedType
	DI-Guy character speed types. More...

Enumerations
enum	{   DIGUY_MOTION_SPEED_TYPE_UNKNOWN = -1, DIGUY_MOTION_SPEED_TYPE_STILL = 0, DIGUY_MOTION_SPEED_TYPE_SLOW, DIGUY_MOTION_SPEED_TYPE_MEDIUM,   DIGUY_MOTION_SPEED_TYPE_FAST, DIGUY_MOTION_SPEED_TYPE_FASTEST, DIGUY_MOTION_SPEED_TYPE_COUNT }

Functions
const char *	diguy_motion_speed_type_to_string (diguyMotionSpeedType motion_speed_type)
	Utility function that converts a diguyMotionSpeedType enum into a string. More...
diguyMotionSpeedType	diguy_motion_speed_type_from_string (const char *string)
	Utility function that converts a string into a diguyMotionSpeedType enum. More...

Macro Definition Documentation

#define CPLUSPLUS_ONLY

Typedef Documentation

typedef int diguyMotionSpeedType

DI-Guy character speed types.

There are times when it is convenient to refer to actions based on roughly how fast they will move a character. When this is possible, DI-Guy uses "speed types".

DIGUY_MOTION_SPEED_TYPE_UNKNOWN

 Error return value.

DIGUY_MOTION_SPEED_TYPE_STILL

 Specifies that character/action should not move.
 For upright characters, this is typically some kind of stand.

DIGUY_MOTION_SPEED_TYPE_SLOW

 Specifies that character/action should move slowly.
 For upright characters, this is typically a shuffle.

DIGUY_MOTION_SPEED_TYPE_MEDIUM

 Specifies that character/action should move at medium,
 or average, speed.
 For upright characters, this is typically a walk.

DIGUY_MOTION_SPEED_TYPE_FAST

 Specifies that character/action should move at a speed
 faster than a walk, but slower than its fastest speed.
 For upright characters, this is typically a jog.

DIGUY_MOTION_SPEED_TYPE_FASTEST

 Specifies that character/action should move at its
 fastest speed.
 For upright characters, this is typically a run.

Enumeration Type Documentation

anonymous enum

Enumerator
DIGUY_MOTION_SPEED_TYPE_UNKNOWN
DIGUY_MOTION_SPEED_TYPE_STILL
DIGUY_MOTION_SPEED_TYPE_SLOW
DIGUY_MOTION_SPEED_TYPE_MEDIUM
DIGUY_MOTION_SPEED_TYPE_FAST
DIGUY_MOTION_SPEED_TYPE_FASTEST
DIGUY_MOTION_SPEED_TYPE_COUNT

Function Documentation

const char* diguy_motion_speed_type_to_string

(

diguyMotionSpeedType

motion_speed_type

)

Utility function that converts a diguyMotionSpeedType enum into a string.

diguyMotionSpeedType diguy_motion_speed_type_from_string

(

const char *

string

)

Utility function that converts a string into a diguyMotionSpeedType enum.