diguyScenarioMergeSettings.h

Go to the documentation of this file.

/*********************************************************************
 ** Copyright (c) 1992-2022 MAK Technologies, Inc.
 ** All rights reserved. 
 *********************************************************************/

/*********************************************************************
 **
 *t  diguyScenarioMergeSettings
 **
 *b    Link against: libdiguy
 */

#ifndef __diguyScenarioMergeSettings_H
#define __diguyScenarioMergeSettings_H

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

#ifdef CPLUSPLUS_ONLY
#include <diguy_constants.h>
class bdiScenarioMergeSettings;
class diguyScenarioMergeSettings;
#endif /* CPLUSPLUS_ONLY */


#include <declspec_diguy.h>

/****************************************************************************/
class BDI_DECLSPEC_diguy diguyScenarioMergeSettings
{

public:

/****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function sets the time offset, in seconds, of the
         **    merged scenario from the existing scenario.
         **
         **    The default value is 0, or no time offset.
         **
         *b  Arguments:
         **
         *a    t - time offset in seconds; must be >= 0
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_time_offset(float t);

        /*l
         *b  Returns:
         **
         **    time offset as set by set_time_offset()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        float get_time_offset();

        /*l
         *b  Description:
         **
         **    This function sets the position offset, in meters, of the
         **    merged scenario from its original position.
         **
         **    The default values are 0,0,0, or no position change.
         **
         *b  Arguments:
         **
         *a    tx, ty, tz - position offset in meters
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_position_offset(float tx, float ty, float tz);

        /*l
         *b  Returns:
         **
         **    position offset as set by set_position_offset()
         **
         *b  Arguments:
         **
         *a    tx, ty, tz - position offset in meters
         **
         **    Pass NULL for any values that are not needed.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_position_offset(float* tx, float* ty, float* tz);

        /*l
         *b  Description:
         **
         **    This function sets the orientation offset, in degrees, of the
         **    merged scenario from its original orientation.  The rotation is
         **    done about the point set by the function
         **    set_transformation_reference_point() below.
         **
         **    The default values are 0,0,0, or no orientation change.
         **
         *b  Arguments:
         **
         *a    rz, rx, ry - orientation offset in degrees
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_orientation_offset(float rz, float rx, float ry);

        /*l
         *b  Returns:
         **
         **    orientation offset as set by set_orientation_offset()
         **
         *b  Arguments:
         **
         *a    rz, rx, ry - orientations in degrees counter-clockwise from the
         *a                 positive X axis
         **
         **    Pass NULL for any values that are not needed.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_orientation_offset(float* rz, float* rx, float* ry);

        /*l
         *b  Description:
         **
         **    This function sets the point about which the orientation offset
         **    rotation will be done.
         **
         **    The default values are 0,0,0, or the origin.
         **
         *b  Arguments:
         **
         *a    tx, ty, tz - reference point location in meters from the origin
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_transformation_reference_point(float tx, float ty, float tz);

        /*l
         *b  Returns:
         **
         **    reference point location as set by set_position_offset()
         **
         *b  Arguments:
         **
         *a    tx, ty, tz - reference point location in meters from the origin
         **
         **    Pass NULL for any values that are not needed.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_transformation_reference_point(float* tx, float* ty, float* tz);

        /*l
         *b  Description:
         **
         **    This function sets whether waypoints of any paths or path shapes
         **    in the merged scenario are ground clamped after they have had
         **    either a position or orientation offset applied.
         **
         **    The default value is 1, re-clamp waypoints.
         **
         *b  Arguments:
         **
         *a    reclamp_waypoints_flag - pass 1 to re-clamp waypoints; pass 0
         *a                             to not do so
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_reclamp_waypoints_flag(int reclamp_waypoints_flag);

        /*l
         *b  Returns:
         **
         **    whether to re-clamp waypoints, as set by
         **    set_reclamp_waypoints_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int get_reclamp_waypoints_flag();


/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function sets all merge flags to not merge.  Individual flags
         **    can the be modified to enable merges of specific types.
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        void set_all_merge_flags_to_dont_merge();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.  Since there are a set number of camera settings
         **    the options for the merge_flag argument are limited.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
         *a                 or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_camera_settings_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_camera_settings_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_camera_settings_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_chain_settings_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_chain_settings_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_chain_settings_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_character_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_character_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_character_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_crowd_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_crowd_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_crowd_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_crowd_profile_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_crowd_profile_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_crowd_profile_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_decision_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_decision_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_decision_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_face_exp_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_face_exp_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_face_exp_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.  Since there are a set number of fog settings
         **    the options for the merge_flag argument are limited.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
         *a                 or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_fog_settings_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_fog_settings_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_fog_settings_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_formation_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_formation_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_formation_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_group_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_group_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_group_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_guide_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_guide_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_guide_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_info_popup_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_info_popup_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_info_popup_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_library_function_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_library_function_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_library_function_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.  Since there are a set number of light settings
         **    the options for the merge_flag argument are limited.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
         *a                 or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_light_settings_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_light_settings_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_light_settings_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_particle_system_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_particle_system_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_particle_system_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_path_shape_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_path_shape_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_path_shape_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_region_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_region_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_region_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how scenario settings should be merged.
         **    Since there is only one set of scenario settings per scenario,
         **    the options for the merge_flag argument are limited.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set only to DIGUY_MERGE_FLAG_DONT_MERGE
         *a                 or DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_scenario_settings_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_scenario_settings_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_scenario_settings_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_scene_object_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_scene_object_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_scene_object_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_scene_object_grid_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_scene_object_grid_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_scene_object_grid_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_script_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_script_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_script_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_sensor_region_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_sensor_region_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_sensor_region_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_signal_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_signal_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_signal_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_sound_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_sound_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_sound_merge_flag();

        /*l
         *b  Description:
         **
         **    This function sets how objects of the specified type should
         **    be merged.
         **
         *b  Arguments:
         **
         *a    merge_flag - can be set to any merge flag value except
         *a                 DIGUY_MERGE_FLAG_OVERWRITE_EXISTING
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_variable_merge_flag(diguyScenarioMergeFlag merge_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_variable_merge_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeFlag get_variable_merge_flag();


/*****************************************************************************/
        /*l
         *b  Description:
         **
         **    This function sets what scenario elements will be reset after
         **    the merge is complete.
         **
         *b  Arguments:
         **
         *a    reset_flag -  DIGUY_MERGE_RESET_NONE, (reset nothing) or
         *a                  DIGUY_MERGE_RESET_MERGED, (reset only merged
         *a                  elements) or DIGUY_MERGE_RESET_ALL (reset
         *a                  entire scenario); default is
         *a                  DIGUY_MERGE_RESET_ALL
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_reset_flag(diguyScenarioMergeResetFlag reset_flag);

        /*l
         *b  Returns:
         **
         **    most recent value set by set_reset_flag()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        diguyScenarioMergeResetFlag get_reset_flag();

        /*l
         *b  Description:
         **
         **    This function sets the prefix that will be added to merged
         **    object names if they are renamed.
         **
         **    The default value is the empty string, or no rename prefix.
         **
         **    If neither a prefix nor suffix are specified, a prefix will
         **    be derived and used to resolve name conflicts.
         **
         *b  Arguments:
         **
         *a    rename_prefix - string to be prepended to object names
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_rename_prefix(const char* rename_prefix);

        /*l
         *b  Returns:
         **
         **    prefix to be prepended to object names as set by
         **    set_rename_prefix(); this pointer will never be NULL, but may
         **    be the empty string
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_rename_prefix();

        /*l
         *b  Description:
         **
         **    This function sets the suffix that will be added to merged
         **    object names if they are renamed.
         **
         **    The default value is the empty string, or no rename suffix.
         **
         **    If neither a prefix nor suffix are specified, a prefix will
         **    be derived and used to resolve name conflicts.
         **
         *b  Arguments:
         **
         *a    rename_suffix - string to be appended to object names
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_rename_suffix(const char* rename_suffix);

        /*l
         *b  Returns:
         **
         **    prefix to be appended to object names as set by
         **    set_rename_suffix(); this pointer will never be NULL, but may
         **    be the empty string
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_rename_suffix();

        /*l
         *b  Description:
         **
         **    Sets the group characters in the merged scenario should
         **    be added to.  This group will be created if it doesn't
         **    already exist.
         **
         **    By default merged characters will not be added to any
         **    group they are not already in the merged scenario.
         **
         *b  Returns:
         **
         **    0 on success, -1 on failure
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        int set_character_group(const char* group_name);

        /*l
         *b  Returns:
         **
         **    the most recent setting made by set_character_group()
         **
         *b  Callable From:
         **
         *-    - C++
         *-    - Script
         */
        const char* get_character_group();


#ifdef CPLUSPLUS_ONLY

private:

        /*l
         **    A private constructor.
         */
        diguyScenarioMergeSettings(bdiScenarioMergeSettings* merge_settings);

        /*l
         **    A pointer to internal data.
         */
        bdiScenarioMergeSettings* m_scripted_object;

        friend class bdiScenarioMergeSettings;
        friend class diguyScenario;

#endif /* CPLUSPLUS_ONLY */

};

#endif /* __diguyScenarioMergeSettings_H */