aiAgent.h

/*

Jump'n'Run Engine
http://www.atanaslaskov.com/jnr/

BSD LICENSE
Copyright (c) 2007-2013, Atanas Laskov
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
1. Redistributions of source code must retain the above copyright notice,
this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL ATANAS LASKOV BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

*/
#ifndef AI_AGNET_H
#define AI_AGNET_H



#define P__PLAYER_DISTANCE      0       //distance to the player

#define P__PLAYER_IN_TERRITORY  1       //player in creature territory
#define P__PLAYER_IN_RANGE      2       //player in creature attack/act range
#define P__PLAYER_TOUCHED       3       //player touches the creature
#define P__PLAYER_ATTACKS       4       //player attacks the creature

#define P__PLAYER_ACTION        5       //player performs action


class aiAgent: public laLoadableObj, public laClassFactory
{
protected:

    // AI activation flag
    //
    M_BOOL _bActive;
    M_BOOL _bInitialized;

    // List of agent percepts
    //
    aiPercepts  _percepts;          //< Personal percepts
    aiPercepts* _perceptsGlobal;    //< Global percepts; Stored in the level object to represent global events

    // Agent controllers,
    // i.e. game objects that can be manipulated by the AI agent
    //
    aiController* _self;        //< Self controller
    aiController* _player;      //< Player controller

    // List of agent states,
    // The active state responds to percept events
    //
    // Note: String identifiers are more convenient,
    // because they can be copied directly when the
    // aiAgent object is loaded from file;
    // There is a small number of states, and only 1 active,
    // so this should not be reasonably efficient
    //
    std::map<std::string, aiAgentState*> _vStates;
    std::string   _strCurrentState;     // ID of active state
    aiAgentState* _pCurrentState;       // also store a pointer for quick access

    // Map of aiAgentState types
    //std::map<std::string, aiAgentState*>

    //virtual void perceive_any(laTimer *pt) = 0;

public:

    // Constructor
    //
    aiAgent();

    // AI activation
    //
    void activate(M_BOOL active = M_TRUE) { _bActive = active; }
    M_BOOL isActive() { return _bActive; }

    // Reset agent state
    //
    void reset() { _bInitialized = M_FALSE; } // triggers the on activate percept

    // Set controller objects
    //
    void controllers(aiController* pSelf, aiController *pPlayer, aiPercepts* pGlobalPercepts);

    // State management
    //
    void add(std::string id, aiAgentState* pState);     //< Add state
    void state(std::string id);                         //< Set current state
    std::string state() { return _strCurrentState; }    //< Get current state

    // Percept management
    //
    void perceive(unsigned id, aiPerceptData data = aiPerceptData() );  //< Set percept

    M_BOOL isPerceiving(unsigned id)                                    //< Check if percept is present
    {
        if( _percepts.find(id) != _percepts.end()) return M_TRUE;
        else return M_FALSE;
    }

    void perceptsClear();   //< Clear percepts
                            //< NOTE: This call should be made after every simulation step,
                            //< otherwise old percepts will accumulate

    // Execute a discrete step of the AI agent,
    // This function calls all the percept handlers
    //
    virtual void execute(class laTimer *pt);

    // Load aiAgent form file
    // The function reads up a list of aiAgentState identifiers,
    // creates an appropriate aiAgent state object for each one
    // and registers them with aiAgent::add()
    virtual void load(class laFileParser *fp);
};
#endif