psattackqueue.h

Go to the documentation of this file.

 /*
 * psattackqueue.cpp              creator [email protected]
 *
 * Copyright (C) 2001-2011 Atomic Blue ([email protected], http://www.atomicblue.org)
 *
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation (version 2 of the License)
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 *
 */
#ifndef psAttackQueue_HEADER
#define psAttackQueue_HEADER


//====================================================================================
// Crystal Space Includes
//====================================================================================
#include <csutil/csstring.h>
#include <csutil/list.h>

//====================================================================================
// Project Includes
//====================================================================================
#include <idal.h>
#include "psattack.h"

class psAttackQueue : public csRefCount
{
public:

    /*
     * Constructor
     */
    psAttackQueue(psCharacter* pschar);

    /*
     * Pushes attack into the last slot of the queue.
     * @param attack the attack to push into the last slot of the queue
     */
    bool Push(psAttack* attack);

    /*
     * Removes the first slot in the queue.
     */
    bool Pop();

    /*
     * Returns the first slot in the queue without removing it.
     */
    psAttack* First();

    /*
     * Discards all items in the queue.
     */
    void Purge();

    /*
     * Returns the list of special attacks in the queue.
     */
    csList< csRef<psAttack> >& getAttackList();

    /*
     * Returns the number of special attacks in the queue.
     */
    size_t getAttackListCount();

private:
    csList< csRef<psAttack> > attackList; 
    psCharacter* character;
};
#endif