[irc/gameservirc.git] / gameserv / flags.h

#ifndef FLAGS_H
#define FLAGS_H

/* This file contains all the flags used in the aClient and Player classes.
 * More flags can be added simply by going up in multiples of 2.
 * ie. 0001 0002 0004 0008 0010 0020 0040 0080 0100 0200 0400 0800 1000 2000 4000
 *     8000 10000 20000 40000 80000 100000 200000 400000 800000 1000000 2000000 4000000
 *     8000000 10000000 20000000 40000000 80000000 (32 bit)
 * This method was taken from my experience in working with various
 * IRCD packages. Most of them use this for their modes along with
 * corresponding letter representations.
 * Theoretically, each flag is 32 bit (long int), and each place in a flag
 * is one hexadecimal digit (four bits). So, technically each flag variable
 * can hold 8 spaces for flags. 8 spaces at 4 flags per space makes for
 * 32 possible flags for each long int. That means there are 32 flags available
 * for the aClient class, and 32 for the player class.
 *
 * Basically if you are having problems visualizing how flags work, think of them in
 * binary terms:
 *	Hex	Binary
 *	0x0001 	0001
 * 	0x0002 	0010
 *	0x0004 	0100
 *	0x0008 	1000
 *     Basically, each flag represents a 1. When you add the different flags, you are just
 *	adding a 1 in the given position. So 1001 would be 0x0009 or flags 0001 and 0008.
 */

// aClient FLAGS ONLY
#define FLAG_ADMIN 0x0001

// PLAYER FLAGS ONLY
#define FLAG_MASTER		0x0001
#define FLAG_ALIVE		0x0002
#define FLAG_YOURTURN		0x0004
#define FLAG_WONGAME		0x0008


// aClient flags
// #define ADMIN_FLAGS(FLAG_ONE | FLAG_TWO | FLAG_ETC)
#define ADMIN_FLAGS (FLAG_ADMIN)

#define setAdmin(x)	((x)->addFlag(FLAG_ADMIN))
#define clearAdmin(x)	((x)->remFlag(FLAG_ADMIN))
#define isAdmin(x)	((x)->getFlags() & FLAG_ADMIN)

#define clearAdminFlags(x)	((x)->remFlag(ADMIN_FLAGS))


// Player Flags
#define seenMaster(x)		((x)->getFlags() & FLAG_MASTER)
#define setMaster(x)		((x)->addFlag(FLAG_MASTER))
#define clearMaster(x)		((x)->remFlag(FLAG_MASTER))

#define isAlive(x)		((x)->getFlags() & FLAG_ALIVE)
#define setAlive(x)		((x)->addFlag(FLAG_ALIVE))
#define clearAlive(x)		((x)->remFlag(FLAG_ALIVE))

#define isYourTurn(x)		((x)->getFlags() & FLAG_YOURTURN)
#define setYourTurn(x)  	((x)->addFlag(FLAG_YOURTURN))
#define clearYourTurn(x)	((x)->remFlag(FLAG_YOURTURN))

#define hasWonGame(x)		((x)->getFlags() & FLAG_WONGAME)
#define setWonGame(x)		((x)->addFlag(FLAG_WONGAME))
#define clearWonGame(x)		((x)->remFlag(FLAG_WONGAME))

#endif
Commit	Line	Data
108f1888	1	#ifndef FLAGS_H
	2	#define FLAGS_H
	3
1af35752	4	/* This file contains all the flags used in the aClient and Player classes.
108f1888	5	* More flags can be added simply by going up in multiples of 2.
1af35752	6	* ie. 0001 0002 0004 0008 0010 0020 0040 0080 0100 0200 0400 0800 1000 2000 4000
	7	* 8000 10000 20000 40000 80000 100000 200000 400000 800000 1000000 2000000 4000000
	8	* 8000000 10000000 20000000 40000000 80000000 (32 bit)
108f1888	9	* This method was taken from my experience in working with various
	10	* IRCD packages. Most of them use this for their modes along with
	11	* corresponding letter representations.
1af35752	12	* Theoretically, each flag is 32 bit (long int), and each place in a flag
	13	* is one hexadecimal digit (four bits). So, technically each flag variable
	14	* can hold 8 spaces for flags. 8 spaces at 4 flags per space makes for
	15	* 32 possible flags for each long int. That means there are 32 flags available
	16	* for the aClient class, and 32 for the player class.
0d012394	17	*
	18	* Basically if you are having problems visualizing how flags work, think of them in
	19	* binary terms:
	20	* Hex Binary
	21	* 0x0001 0001
	22	* 0x0002 0010
	23	* 0x0004 0100
	24	* 0x0008 1000
	25	* Basically, each flag represents a 1. When you add the different flags, you are just
	26	* adding a 1 in the given position. So 1001 would be 0x0009 or flags 0001 and 0008.
108f1888	27	*/
108f1888	28
1af35752	29	// aClient FLAGS ONLY
108f1888	30	#define FLAG_ADMIN 0x0001
108f1888	31
1af35752	32	// PLAYER FLAGS ONLY
ee38284f	33	#define FLAG_MASTER 0x0001
	34	#define FLAG_ALIVE 0x0002
	35	#define FLAG_YOURTURN 0x0004
9ea839ce	36	#define FLAG_WONGAME 0x0008
108f1888	37
108f1888	38
1af35752	39	// aClient flags
	40	// #define ADMIN_FLAGS(FLAG_ONE \| FLAG_TWO \| FLAG_ETC)
	41	#define ADMIN_FLAGS (FLAG_ADMIN)
108f1888	42
	43	#define setAdmin(x) ((x)->addFlag(FLAG_ADMIN))
	44	#define clearAdmin(x) ((x)->remFlag(FLAG_ADMIN))
	45	#define isAdmin(x) ((x)->getFlags() & FLAG_ADMIN)
	46
1af35752	47	#define clearAdminFlags(x) ((x)->remFlag(ADMIN_FLAGS))
	48
	49
	50	// Player Flags
ee38284f	51	#define seenMaster(x) ((x)->getFlags() & FLAG_MASTER)
	52	#define setMaster(x) ((x)->addFlag(FLAG_MASTER))
	53	#define clearMaster(x) ((x)->remFlag(FLAG_MASTER))
	54
	55	#define isAlive(x) ((x)->getFlags() & FLAG_ALIVE)
	56	#define setAlive(x) ((x)->addFlag(FLAG_ALIVE))
	57	#define clearAlive(x) ((x)->remFlag(FLAG_ALIVE))
1af35752	58
ee38284f	59	#define isYourTurn(x) ((x)->getFlags() & FLAG_YOURTURN)
	60	#define setYourTurn(x) ((x)->addFlag(FLAG_YOURTURN))
	61	#define clearYourTurn(x) ((x)->remFlag(FLAG_YOURTURN))
1af35752	62
9ea839ce	63	#define hasWonGame(x) ((x)->getFlags() & FLAG_WONGAME)
	64	#define setWonGame(x) ((x)->addFlag(FLAG_WONGAME))
	65	#define clearWonGame(x) ((x)->remFlag(FLAG_WONGAME))
	66
108f1888	67	#endif