diguyCharacterGuide Class Declaration

diguyCharacterGuide.h

DI-Guy API Version 5.1.26

This file was automatically generated from comments in the C/C++ header file diguyCharacterGuide.h. Do not edit this file directly; the changes will be lost. Please mail suggestions or corrections to diguy@bdi.com

Alphabetical Index

Includes: declspec_diguy.h

class diguyCharacterGuide

class BDI_DECLSPEC_diguy diguyCharacterGuide
{
public:
    const char* get_name();
    int set_enabled(int enabled);
    int get_enabled();
    int set_guide_algorithm_float_parameter(const char* parameter,
        float value);
    float get_guide_algorithm_float_parameter(const char* parameter);
#ifdef CPLUSPLUS_ONLY
    bdiScenarioCharacterGuide* get_scripted_object() {return m_scripted_object;}
};

function diguyCharacterGuide::get_name

Prototype:

const char* get_name();
Returns:

name of the guide

Callable From:

function diguyCharacterGuide::set_enabled

Prototype:

int set_enabled(int enabled);
Description:

This function enables or disables this guide.

Callable From:

Arguments:

enabled pass 1 to enable to guide, 0 to disable
Returns:

0 on success, -1 on failure

function diguyCharacterGuide::get_enabled

Prototype:

int get_enabled();
Returns:

whether this guide is enabled; see set_enabled()

Callable From:

function diguyCharacterGuide::set_guide_algorithm_float_parameter

Prototype:

int set_guide_algorithm_float_parameter(const char* parameter,
		float value);
Description:

This function sets a parameter for this guide's guide algorithm.

Arguments:

parameter name of the parameter to set
value new value of the parameter
Callable From:

Returns:

0 on success, -1 on failure

function diguyCharacterGuide::get_guide_algorithm_float_parameter

Prototype:

float get_guide_algorithm_float_parameter(const char* parameter);
Description:

This function gets the current setting for a parameter of this guide's guide algorithm.

Arguments:

parameter name of the parameter to get
Callable From:

Returns:

current value of parameter

function diguyCharacterGuide::get_scripted_object

Prototype:

bdiScenarioCharacterGuide* get_scripted_object();

Alphabetical Index


Copyright (C) 1992-2003

Boston Dynamics

ALL RIGHTS RESERVED.

These coded instructions, statements, and computer programs contain unpublished proprietary information of Boston Dynamics and are protected by Copyright Laws of the United States. They may not be used, duplicated, or disclosed in any form, in whole or in part, without the prior written consent from Boston Dynamics.

RESTRICTED RIGHTS LEGEND

Use, duplication, or disclosure by the government is subject to restrictions as set forth in FAR 52.227.19(c)(2) or subparagraph (c)(1)(ii) of the Rights in Technical Data and Computer Sofware clause at DFARS 252.227-7013 and/or in similar or successor clauses in the FAR, or the DOD or NASA FAR Supplement, or to subparagraphs (c)(1) and (c)(2) of the Commercial Computer Software--Restricted Rights at 48 CFR 52.227-19, as applicable. Unpublished-rights reserved under the Copyright Laws of the United States.

Contractor/Manufacturer is:

Boston Dynamics/515 Massachusetts Avenue/Cambridge MA 02139.