diguyCharacterTypeMap.h

Go to the documentation of this file.

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

#pragma once

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

#ifdef CPLUSPLUS_ONLY
class bdiMotgenTypeMap;
class diguyCharacterTypeMapFieldValues;
#include <diguy_constants.h>
#endif

#include <declspec_diguy.h>


BDI_DECLSPEC_diguy
const char* diguy_character_type_map_field_to_string( diguyCharacterTypeMapField field );

BDI_DECLSPEC_diguy
diguyCharacterTypeMapField diguy_character_type_map_field_from_string( const char* string );


/*********************************************************************/
class BDI_DECLSPEC_diguy diguyCharacterTypeMap
{
public:

        /*l
         *b  Description:
         **
         **    This function returns the type map id of this type map object,
         **    in which the current value of all fields are concatenated
         **    together, separated by slashes.
         **
         **    An example return value is
         **    "human/military/soldier/male/adult/black/usa/army/m16".
         **
         *b  Returns:
         **
         **    type map id string; will never be NULL
         */
        const char* get_type_map_id();

        /*l
         *b  Description:
         **
         **    This function returns the character type this type map maps to.
         **    This is important for match results.
         **
         **    The returned character type can be used, for example, in a call
         **    to diguyScenario::create_character().
         **
         *b  Returns:
         **
         **    character type string; will never be NULL
         */
        const char* get_mapped_character_type();

        /*l
         *b  Description:
         **
         **    This function returns the appearance this type map maps to.
         **    This is important for match results.
         **
         **    The returned appearance can be used, for example, in a call
         **    to diguyCharacter::set_appearance().
         **
         *b  Returns:
         **
         **    appearance string; will never be NULL
         */
        const char* get_mapped_appearance();

        /*l
         *b  Returns:
         **
         **    the value of the specified field
         */
        const char* get_field_value( diguyCharacterTypeMapField field );

        /*l
         *b  Returns:
         **
         **    the value of the specified field
         */
        const diguyCharacterTypeMapFieldValues& get_field_values();

        /*l
         *b  Returns:
         **
         **    the value of the specified field
         */
        const char* get_field_value_using_field_string( const char* field );


/*********************************************************************
 **
 *2  Type Map Query Result Functions
 **
 **    Some functions query DI-Guy for the closest match of
 **    character type and appearance to specified type map field
 **    selections.  The result of such a query is returned in
 **    a diguyCharacterTypeMap object.
 **
 **    These functions return information from the returned object
 **    about whether there was actually a match, how many exact
 **    field matches there were, etc.
 */

        /*l
         *b  Description:
         **
         **    Performs a match check against the given field values (and alternates, if given).
         **
         **    This will update the most recent values returned by the following accessors.
         **
         *b  Returns:
         **
         **    The total match value for the match operation. Higher number
         **    means better match. If match level is 0, match failed.
         */
        int match_level( const diguyCharacterTypeMapFieldValues& field_values,
                const diguyCharacterTypeMapFieldValues* alternate_values = nullptr );

        /*l
         *b  Returns:
         **
         **    whether the most recent match call passed or not; 1 if so,
         **    0 if not
         */
        int get_most_recent_match_passed();

        /*l
         *b  Returns:
         **
         **    total match value from most recent match operation; Higher number
         **    means better match. If match level is 0, match failed.
         */
        int get_most_recent_match_level();

        /*l
         *b  Returns:
         **
         **    number of exact value matches in most recent match operation
         */
        int get_most_recent_exact_value_matches();

        /*l
         *b  Returns:
         **
         **    number of alternate value matches in most recent match operation
         */
        int get_most_recent_alternate_value_matches();

        /*l
         *b  Returns:
         **
         **    number of wildcard value matches in most recent match operation
         */
        int get_most_recent_wildcard_value_matches();

        /*l
         *b  Returns:
         **
         **    number of fields that have wildcard values
         */
        int get_num_wildcards();


#ifdef CPLUSPLUS_ONLY

        bdiMotgenTypeMap* get_scripted_object() {return m_scripted_object;}

private:

        /*l
         **    A private constructor.
         */
        diguyCharacterTypeMap( bdiMotgenTypeMap* scripted_object );

        /*l
         **    A private destructor.
         */
        ~diguyCharacterTypeMap();

        /*l
         **    A pointer to internal data.
         */
        bdiMotgenTypeMap* m_scripted_object;
        friend class bdiMotgenTypeMap;

#endif

};