IFriends Class Reference

#include <friends.h>

Inheritance diagram for IFriends:

Collaboration diagram for IFriends:

Public Types
enum	{ FRIEND_NO = 0 , FRIEND_CLAN , FRIEND_PLAYER }

Public Member Functions
virtual void	Init (bool Foes=false)=0
virtual int	NumFriends () const =0
virtual const CFriendInfo *	GetFriend (int Index) const =0
virtual int	GetFriendState (const char *pName, const char *pClan) const =0
virtual bool	IsFriend (const char *pName, const char *pClan, bool PlayersOnly) const =0
virtual void	AddFriend (const char *pName, const char *pClan)=0
virtual void	RemoveFriend (const char *pName, const char *pClan)=0
Public Member Functions inherited from IInterface
	IInterface ()
virtual void	Shutdown ()
virtual	~IInterface ()=default

Static Public Member Functions
static const char *	InterfaceName ()

Static Public Attributes
static constexpr auto	MAX_FRIENDS = 4096

Additional Inherited Members
Protected Member Functions inherited from IInterface
IKernel *	Kernel ()

Member Enumeration Documentation

anonymous enum

anonymous enum

Enumerator
FRIEND_NO
FRIEND_CLAN
FRIEND_PLAYER

Member Function Documentation

AddFriend()

virtual void IFriends::AddFriend ( const char * pName, const char * pClan )

pure virtual

Implemented in CFriends.

GetFriend()

virtual const CFriendInfo * IFriends::GetFriend ( int Index ) const

pure virtual

Implemented in CFriends.

GetFriendState()

virtual int IFriends::GetFriendState ( const char * pName, const char * pClan ) const

pure virtual

Implemented in CFriends.

Init()

virtual void IFriends::Init ( bool Foes = false )

pure virtual

Implemented in CFriends.

InterfaceName()

const char * IFriends::InterfaceName ( )

inlinestatic

IsFriend()

virtual bool IFriends::IsFriend ( const char * pName, const char * pClan, bool PlayersOnly ) const

pure virtual

Implemented in CFriends.

NumFriends()

virtual int IFriends::NumFriends ( ) const

pure virtual

Implemented in CFriends.

RemoveFriend()

virtual void IFriends::RemoveFriend ( const char * pName, const char * pClan )

pure virtual

Implemented in CFriends.

Member Data Documentation

MAX_FRIENDS

auto IFriends::MAX_FRIENDS = 4096

staticconstexpr

---

The documentation for this class was generated from the following file:

• src/engine/friends.h