GamePlay/gameplay/src/ScriptTarget.h

#ifndef SCRIPTTARGET_H_
#define SCRIPTTARGET_H_

#include "Base.h"

namespace gameplay
{

/**
 * Generic base class for supporting script callbacks.
 */
class ScriptTarget
{
public:

    /**
     * Adds the given Lua script function as a callback for the given event.
     * 
     * @param eventName The name of the event.
     * @param function The name of the Lua script function to call when the event is fired; can either be
     *      just the name of a function (if the function's script file has already been loaded), or can be
     *      a URL of the form scriptFile.lua#functionName.
     */
    virtual void addScriptCallback(const std::string& eventName, const std::string& function);

    /**
     * Removes the given Lua script function as a callback for the given event.
     * 
     * @param eventName The name of the event.
     * @param function The name of the Lua script function.
     */
    virtual void removeScriptCallback(const std::string& eventName, const std::string& function);

protected:

    /**
     * Hidden constructor.
     */
    ScriptTarget();

    /**
     * Destructor.
     */
    virtual ~ScriptTarget();

    /**
     * Adds the given event with the given Lua script parameter string ({@link ScriptController::executeFunction})
     * as a supported event for this script target.
     * 
     * @param eventName The name of the event.
     * @param argsString The argument string for the event.
     */
    void addScriptEvent(const std::string& eventName, const char* argsString = NULL);

    /**
     * Fires the event with the given event name and the given arguments.
     * 
     * @param eventName The name of the event.
     */
    template<typename T> T fireScriptEvent(const char* eventName, ...);

    /** Used to store a script callbacks for given event. */
    struct Callback
    {
        /** Constructor. */
        Callback(const std::string& string);

        /** Holds the Lua script callback function. */
        std::string function;
    };

    /** Holds the supported events for this script target. */
    std::map<std::string, std::string> _events;
    /** Holds the callbacks for this script target's events. */
    std::map<std::string, std::vector<Callback>*> _callbacks;
};

template<typename T> T ScriptTarget::fireScriptEvent(const char* eventName, ...)
{
    GP_ERROR("Unsupported return type!");
}

/** Template specialization. */
template<> void ScriptTarget::fireScriptEvent<void>(const char* eventName, ...);
/** Template specialization. */
template<> bool ScriptTarget::fireScriptEvent<bool>(const char* eventName, ...);

}

#endif