diguyCharacterPathEvent Class Reference

Interface to base class of event beads, not often used. More...

#include <diguyCharacterPathEvent.h>

Public Member Functions
const char *	get_name ()
	Returns the name of the bead. More...
diguyCharacter *	get_character ()
	This function returns a pointer to the character owning this event bead. More...
diguyCharacterPath *	get_path ()
	This function returns a pointer to the path owning this event bead. More...
float	get_how_far ()
	Returns: returns how far the character is into this bead. More...

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

Detailed Description

Interface to base class of event beads, not often used.

Constructor & Destructor Documentation

diguyCharacterPathEvent::diguyCharacterPathEvent ( bdiBeadEvent *  bead )

private

A private constructor.

Member Function Documentation

const char* diguyCharacterPathEvent::get_name

(

)

Returns the name of the bead.

This pointer will never be NULL.

Returns:

name of the bead

Callable From:

• C++
• Script

diguyCharacter* diguyCharacterPathEvent::get_character

(

)

This function returns a pointer to the character owning this event bead.

Returns:

pointer of type diguyCharacter

Callable From:

• C++
• Script

diguyCharacterPath* diguyCharacterPathEvent::get_path

(

)

This function returns a pointer to the path owning this event bead.

Returns:

pointer of type diguyCharacterPath

Callable From:

• C++
• Script

float diguyCharacterPathEvent::get_how_far

(

)

Returns: returns how far the character is into this bead.

This is a normalized value. 0 means beginning of bead, 0.5 means halfway through, 1 means end of bead

Callable From:

• C++
• Script

Friends And Related Function Documentation

friend class bdiBeadEvent

friend

Member Data Documentation

bdiBeadEvent* diguyCharacterPathEvent::m_scripted_object

private

A pointer to internal data.

---

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

• diguyCharacterPathEvent.h