ScummVM API documentation
MADS::GameConversations Class Reference

#include <conversations.h>

Public Member Functions

 GameConversations (MADSEngine *vm)
 
virtual ~GameConversations ()
 
void load (int id)
 
void run (int id)
 
void setVariable (uint idx, int val)
 
void setVariable (uint idx, int *val)
 
void setStartNode (uint nodeIndex)
 
void setHeroTrigger (int val)
 
void setInterlocutorTrigger (int val)
 
int * getVariable (int idx)
 
void hold ()
 
void release ()
 
void stop ()
 
void exportPointer (int *ptr)
 
void exportValue (int val)
 
void reset (int id)
 
void update (bool flag)
 
bool active () const
 
int activeConvId () const
 
int restoreRunning () const
 
ConversationMode currentMode () const
 

Detailed Description

Manager for loading and running conversations

Constructor & Destructor Documentation

◆ GameConversations()

MADS::GameConversations::GameConversations ( MADSEngine vm)

Constructor

◆ ~GameConversations()

virtual MADS::GameConversations::~GameConversations ( )
virtual

Destructor

Member Function Documentation

◆ load()

void MADS::GameConversations::load ( int  id)

Gets the specified conversation and loads into into a free slot in the conversation list

◆ run()

void MADS::GameConversations::run ( int  id)

Run a specified conversation number. The conversation must have previously been loaded by calling the load method

◆ setVariable() [1/2]

void MADS::GameConversations::setVariable ( uint  idx,
int  val 
)

Sets a variable to a numeric value

◆ setVariable() [2/2]

void MADS::GameConversations::setVariable ( uint  idx,
int *  val 
)

Sets a variable to a pointer value

◆ setStartNode()

void MADS::GameConversations::setStartNode ( uint  nodeIndex)

Sets the starting node index

◆ setHeroTrigger()

void MADS::GameConversations::setHeroTrigger ( int  val)

Set the hero trigger

◆ setInterlocutorTrigger()

void MADS::GameConversations::setInterlocutorTrigger ( int  val)

Set the interlocutor trigger

◆ getVariable()

int* MADS::GameConversations::getVariable ( int  idx)

Returns either the pointer value of a variable, or if the variable contains a numeric value directly, returns a pointer to it

◆ hold()

void MADS::GameConversations::hold ( )

Hold the current mode value

◆ release()

void MADS::GameConversations::release ( )

Release the prevoiusly held mode value

◆ stop()

void MADS::GameConversations::stop ( )

Stop any currently running conversation

◆ exportPointer()

void MADS::GameConversations::exportPointer ( int *  ptr)

Adds the passed pointer into the list of import variables for the given conversation

◆ exportValue()

void MADS::GameConversations::exportValue ( int  val)

Adds the passed value into the list of import variables for the given conversation

◆ update()

void MADS::GameConversations::update ( bool  flag)

Handles updating the conversation display

◆ active()

bool MADS::GameConversations::active ( ) const
inline

Returns true if any conversation is currently atcive

◆ activeConvId()

int MADS::GameConversations::activeConvId ( ) const
inline

Returns the currently active conversation Id

◆ restoreRunning()

int MADS::GameConversations::restoreRunning ( ) const
inline

Returns _restoreRunning value

◆ currentMode()

ConversationMode MADS::GameConversations::currentMode ( ) const
inline

Returns the current conversation mode


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