dtGame::Invokable Class Reference

An Invokable is a queriable method interface that can be added to a dtGame::GameActorProxy just as a dtDAL::ActorProperty represents a data value on the actor. More...

#include <invokable.h>

List of all members.

Public Member Functions

 Invokable (const std::string &name, dtDAL::Functor1< const Message & > toInvoke)
const std::string & GetName () const
 
Returns:
the name of this invokable.

void Invoke (const Message &message)
 Invoke this.

Protected Member Functions

virtual ~Invokable ()
 refenceced classes should always have protected desctructor


Detailed Description

An Invokable is a queriable method interface that can be added to a dtGame::GameActorProxy just as a dtDAL::ActorProperty represents a data value on the actor.

Invoking the invokable requires a dtGame::Message as a parameter. The actual code is executed by calling a Functor that takes 1 parameter, the message, and returns nothing. The method must take a const Method reference.

See also:
dtGame::Message

Constructor & Destructor Documentation

dtGame::Invokable::Invokable ( const std::string &  name,
dtDAL::Functor1< const Message & >  toInvoke 
)

dtGame::Invokable::~Invokable (  )  [protected, virtual]

refenceced classes should always have protected desctructor


Member Function Documentation

const std::string& dtGame::Invokable::GetName (  )  const [inline]

Returns:
the name of this invokable.

void dtGame::Invokable::Invoke ( const Message message  ) 

Invoke this.

Parameters:
message the message to invoke.


http://www.delta3d.org
2.0.0 generated 14 Feb 2008