psguildinfo.h

Go to the documentation of this file.

/*
 * psguildinfo.h
 *
 * Copyright (C) 2003 Atomic Blue (info@planeshift.it, 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 __PSGUILDINFO_H__
#define __PSGUILDINFO_H__
//=============================================================================
// Crystal Space Includes
//=============================================================================
#include <csutil/ref.h>
#include <csutil/refarr.h>
#include <csutil/refcount.h>
#include <csutil/weakreferenced.h>

//=============================================================================
// Project Includes
//=============================================================================
#include "util/psconst.h"

#include "rpgrules/psmoney.h"

//=============================================================================
// Local Includes
//=============================================================================


class psCharacter;
class iResultRow;

enum GUILD_PRIVILEGE
{
    RIGHTS_VIEW_CHAT         = 1,      

    RIGHTS_CHAT              = 2,      

    RIGHTS_INVITE            = 4,      

    RIGHTS_REMOVE            = 8,      

    RIGHTS_PROMOTE           = 16,     

    RIGHTS_EDIT_LEVEL         = 32,    

    RIGHTS_EDIT_POINTS        = 64,    

    RIGHTS_EDIT_GUILD         = 128,   

    RIGHTS_EDIT_PUBLIC        = 256,   

    RIGHTS_EDIT_PRIVATE       = 512,   

    RIGHTS_VIEW_CHAT_ALLIANCE = 1024,  

    RIGHTS_CHAT_ALLIANCE      = 2048,  

    RIGHTS_USE_BANK           = 4096   
};

struct psGuildLevel
{
    csString title;      
    int      level;      
    int      privileges; 

    inline bool HasRights(GUILD_PRIVILEGE rights) const
    {
        return (level == MAX_GUILD_LEVEL) || (privileges & rights);
    }
};

//------------------------------------------------------------------------------

class psGuildMember
{
public:
    PID char_id;                
    csString name;              
    psCharacter*  character;    
    psGuildLevel* guildlevel;   
    int guild_points;           
    csString public_notes;      
    csString private_notes;     
    csString last_login;        
    int privileges;             
    int removedPrivileges;      

    bool HasRights(GUILD_PRIVILEGE rights)
    {
        return (guildlevel->HasRights(rights) && !(removedPrivileges & rights)) || (privileges & rights);
    }
};

//------------------------------------------------------------------------------

class psGuildInfo
{
protected:
    int id;                          
    csString name;                   
    PID founder;                     
    int karma_points;                
    csString web_page;               
    csString motd;                   
    bool secret;                     
    psMoney bankMoney;               
    int max_guild_points;            
    csTicks lastNameChange;          
    int alliance;                    
    csArray<psGuildMember*> members; 
    csArray<psGuildLevel*>  levels;  
    csArray<int> guild_war_with_id;  
    friend class psGuildAlliance;

public:
    psGuildInfo();

    psGuildInfo(csString name, PID founder);

    ~psGuildInfo();

    bool Load(unsigned int id);

    bool Load(const csString &name);

    bool Load(iResultRow &row);

    bool InsertNew();

    bool RemoveGuild();

    void Connect(psCharacter* player);

    void Disconnect(psCharacter* player);

    void UpdateLastLogin(psCharacter* player);

    psGuildMember* FindMember(const char* name) const;

    psGuildMember* FindMember(PID char_id) const;

    psGuildMember* FindLeader() const;

    psGuildLevel* FindLevel(int level) const;

    bool MeetsMinimumRequirements() const;

    bool AddNewMember(psCharacter* player, int level=1);

    bool RemoveMember(psGuildMember* target);

    bool RenameLevel(int level, const char* levelname);

    bool SetPrivilege(int level, GUILD_PRIVILEGE privilege, bool on);

    bool SetMemberPrivilege(psGuildMember* member, GUILD_PRIVILEGE privilege, bool on);

    bool UpdateMemberLevel(psGuildMember* target, int level);

    inline void AdjustMoney(const psMoney &money, bool unused)
    {
        unused = unused;
        AdjustMoney(money);
    }

    void AdjustMoney(const psMoney &money);

    inline psMoney &GetBankMoney()
    {
        return bankMoney;
    }

    void SaveBankMoney();

    unsigned int MinutesUntilUserChangeName() const;

    inline const csString &GetName() const
    {
        return name;
    }

    bool SetMaxMemberPoints(int points);

    inline int GetMaxMemberPoints() const
    {
        return max_guild_points;
    }

    bool SetMemberPoints(psGuildMember* member, int points);

    bool SetMemberNotes(psGuildMember* member, const csString &notes, bool isPublic);

    bool SetName(csString guildName);

    inline const csString &GetWebPage() const
    {
        return web_page;
    }

    bool SetWebPage(const csString &web_page);

    bool SetSecret(bool secretGuild);

    inline bool IsSecret() const
    {
        return secret;
    }

    inline const csString &GetMOTD() const
    {
        return motd;
    }

    bool SetMOTD(const csString &str);

    inline int GetKarmaPoints() const
    {
        return karma_points;
    }

    bool SetKarmaPoints(int n_karma_points);

    void AddGuildWar(psGuildInfo* other);

    bool IsGuildWarActive(psGuildInfo* other);

    void RemoveGuildWar(psGuildInfo* other);

    inline int GetAllianceID() const
    {
        return alliance;
    }

    inline int GetID() const
    {
        return id;
    }

    inline csArray<psGuildLevel*>::ConstIterator GetLevelIterator() const
    {
        return levels.GetIterator();
    }

    inline csArray<psGuildLevel*>::Iterator GetLevelIterator()
    {
        return levels.GetIterator();
    }

    inline csArray<psGuildMember*>::ConstIterator GetMemberIterator() const
    {
        return members.GetIterator();
    }

    inline csArray<psGuildMember*>::Iterator GetMemberIterator()
    {
        return members.GetIterator();
    }

    inline size_t GetMemberCount() const
    {
        return members.GetSize();
    }
};

//-----------------------------------------------------------------------------

class psGuildAlliance : public csRefCount
{
public:

    psGuildAlliance();

    psGuildAlliance(const csString &n_name);

    bool InsertNew();

    bool RemoveAlliance();

    bool Load(int id);

    bool AddNewMember(psGuildInfo* member);

    bool CheckMembership(psGuildInfo* member) const;

    bool RemoveMember(psGuildInfo* member);

    inline size_t GetMemberCount() const
    {
        return members.GetSize();
    }

    psGuildInfo* GetMember(int memberNum);

    inline int GetID() const
    {
        return id;
    }

    inline const csString &GetName() const
    {
        return name;
    }

    inline psGuildInfo* GetLeader() const
    {
        return leader;
    }

    bool SetLeader(psGuildInfo* newLeader);

    static csString lastError;       

protected:
    int id;                          
    csString name;                   
    psGuildInfo* leader;             
    csArray<psGuildInfo*> members;   
};

#endif