diguyMotionVariant.h

Go to the documentation of this file.

/****************************************************************************
 * Copyright (c) 2021 MAK Technologies, Inc.
 * All rights reserved.
 ****************************************************************************/


/*********************************************************************
 **
 *t  diguyMotionVariant Type Declaration
 **
 */

#pragma once

#include <declspec_diguy.h>

#ifdef SWIG
%module diguyMotionVariant
#else
#define CPLUSPLUS_ONLY
#endif

extern "C"
{

        typedef enum
        {
                DIGUY_MOTION_VARIANT_NORMAL = 0,
                DIGUY_MOTION_VARIANT_AIM,
                DIGUY_MOTION_VARIANT_DEAD,

                DIGUY_MOTION_VARIANT_ANGRY,
                DIGUY_MOTION_VARIANT_AMBIENT,
                DIGUY_MOTION_VARIANT_ASSAULT,
                DIGUY_MOTION_VARIANT_CLIMBING,
                DIGUY_MOTION_VARIANT_CURIOUS,
                DIGUY_MOTION_VARIANT_EXERCISE,
                DIGUY_MOTION_VARIANT_FALLING,
                DIGUY_MOTION_VARIANT_FAST_ROPE,
                DIGUY_MOTION_VARIANT_FUNKY,
                DIGUY_MOTION_VARIANT_INJURED,
                DIGUY_MOTION_VARIANT_IMMOBILE,
                DIGUY_MOTION_VARIANT_READY,
                DIGUY_MOTION_VARIANT_SICK,
                DIGUY_MOTION_VARIANT_SOCIALIZE,
                DIGUY_MOTION_VARIANT_STUNNED,
                DIGUY_MOTION_VARIANT_OTHER,

                DIGUY_MOTION_VARIANT_MISC0,
                DIGUY_MOTION_VARIANT_MISC1,
                DIGUY_MOTION_VARIANT_MISC2,
                DIGUY_MOTION_VARIANT_MISC3,
                DIGUY_MOTION_VARIANT_MISC4,
                DIGUY_MOTION_VARIANT_MISC5,
                DIGUY_MOTION_VARIANT_MISC6,
                DIGUY_MOTION_VARIANT_MISC7,
                DIGUY_MOTION_VARIANT_MISC8,
                DIGUY_MOTION_VARIANT_MISC9,

                DIGUY_MOTION_VARIANT_UNKNOWN,
                DIGUY_MOTION_VARIANT_ANY,
                DIGUY_MOTION_VARIANT_COUNT
        } diguyMotionVariant;

        /*l
         *b  Description:
         **
         **    This function converts the passed variant enumeration into
         **    a NULL-terminated C-style string.
         **
         *b  Returns:
         **
         **    C-style string identifying variant
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        BDI_DECLSPEC_diguy const char* diguy_motion_variant_to_string( diguyMotionVariant variant );

        /*l
         *b  Description:
         **
         **    This function converts the passed C-style string into an
         **    enumerated value.
         **
         **    Variants are used in functions such as
         **    diguyCharacter::get_action_from_description().
         **
         *b  Returns:
         **
         **    enumeration value of variant
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        BDI_DECLSPEC_diguy diguyMotionVariant diguy_motion_variant_from_string( const char* string );

}