diguyInfoPopup Class Reference

#include <diguyInfoPopup.h>

Public Member Functions
const char *	get_name ()
	Returns the name of the info popup. More...
int	set_name (const char *name)
	This function sets the name of this object. More...
int	show (float show_duration=-1.0f)
	This function shows the info popup. More...
int	hide ()
	This function hides the info popup, if it is currently shown. More...
int	is_showing ()
	Returns: Returns 1 if the info popup is showing, 0 if not. More...
int	clear ()
	This function clears the contents of the info popup. More...
int	append_file (const char *filename)
	This function appends the contents of the file identified by filename to the info popup. More...
int	append_string (const char *string)
	This function appends a string to the info popup. More...

Private Functions
The functions and variables past this point are for internal use only. No external access to them is expected or necessary.
bdiScenarioInfoPopup *	m_scripted_object
	A pointer to internal data. More...
class	bdiScenarioInfoPopup
	diguyInfoPopup (bdiScenarioInfoPopup *info_popup)
	A private constructor. More...

Constructor & Destructor Documentation

diguyInfoPopup::diguyInfoPopup ( bdiScenarioInfoPopup *  info_popup )

private

A private constructor.

Member Function Documentation

const char* diguyInfoPopup::get_name

(

)

Returns the name of the info popup.

This pointer will never be NULL.

Returns:

name of the info popup

Callable From:

• C++
• Script

int diguyInfoPopup::set_name

(

const char *

name

)

This function sets the name of this object.

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script

int diguyInfoPopup::show

(

float

show_duration = -1.0f

)

This function shows the info popup.

Parameters

duration	length of time in seconds to show to the info popup;
the	default argument of 1 will show the info popup indefinitely, until the hide() function is called

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script
• Decision Bead

int diguyInfoPopup::hide

(

)

This function hides the info popup, if it is currently shown.

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script
• Decision Bead

int diguyInfoPopup::is_showing

(

)

Returns: Returns 1 if the info popup is showing, 0 if not.

Callable From:

• C++
• Script
• Decision Bead

int diguyInfoPopup::clear

(

)

This function clears the contents of the info popup.

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script

int diguyInfoPopup::append_file

(

const char *

filename

)

This function appends the contents of the file identified by filename to the info popup.

Parameters

filename

name of the file

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script

int diguyInfoPopup::append_string

(

const char *

string

)

This function appends a string to the info popup.

Parameters

string

string to append

Returns:

0 on success, -1 on failure

Callable From:

• C++
• Script

Friends And Related Function Documentation

friend class bdiScenarioInfoPopup

friend

Member Data Documentation

bdiScenarioInfoPopup* diguyInfoPopup::m_scripted_object

private

A pointer to internal data.

---

The documentation for this class was generated from the following file:

• C:/Jenkins/jobs/diguy_apps_13.1_vc10_x64/workspace/include/diguyInfoPopup.h