Document all FOREACH loops.
This commit is contained in:
+12
-7
@@ -364,16 +364,21 @@ PlayerNumber GetNextHumanPlayer( PlayerNumber pn );
|
||||
PlayerNumber GetNextEnabledPlayer( PlayerNumber pn );
|
||||
PlayerNumber GetNextCpuPlayer( PlayerNumber pn );
|
||||
PlayerNumber GetNextPotentialCpuPlayer( PlayerNumber pn );
|
||||
|
||||
#define FOREACH_HumanPlayer( pn ) for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextHumanPlayer(pn) )
|
||||
#define FOREACH_EnabledPlayer( pn ) for( PlayerNumber pn=GetNextEnabledPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextEnabledPlayer(pn) )
|
||||
#define FOREACH_CpuPlayer( pn ) for( PlayerNumber pn=GetNextCpuPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextCpuPlayer(pn) )
|
||||
#define FOREACH_PotentialCpuPlayer( pn ) for( PlayerNumber pn=GetNextPotentialCpuPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextPotentialCpuPlayer(pn) )
|
||||
|
||||
|
||||
MultiPlayer GetNextEnabledMultiPlayer( MultiPlayer mp );
|
||||
|
||||
/** @brief A foreach loop to act on each human Player. */
|
||||
#define FOREACH_HumanPlayer( pn ) for( PlayerNumber pn=GetNextHumanPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextHumanPlayer(pn) )
|
||||
/** @brief A foreach loop to act on each enabled Player. */
|
||||
#define FOREACH_EnabledPlayer( pn ) for( PlayerNumber pn=GetNextEnabledPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextEnabledPlayer(pn) )
|
||||
/** @brief A foreach loop to act on each CPU Player. */
|
||||
#define FOREACH_CpuPlayer( pn ) for( PlayerNumber pn=GetNextCpuPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextCpuPlayer(pn) )
|
||||
/** @brief A foreach loop to act on each potential CPU Player. */
|
||||
#define FOREACH_PotentialCpuPlayer( pn ) for( PlayerNumber pn=GetNextPotentialCpuPlayer((PlayerNumber)-1); pn!=PLAYER_INVALID; pn=GetNextPotentialCpuPlayer(pn) )
|
||||
/** @brief A foreach loop to act on each Player in MultiPlayer. */
|
||||
#define FOREACH_EnabledMultiPlayer( mp ) for( MultiPlayer mp=GetNextEnabledMultiPlayer((MultiPlayer)-1); mp!=MultiPlayer_Invalid; mp=GetNextEnabledMultiPlayer(mp) )
|
||||
|
||||
|
||||
|
||||
extern GameState* GAMESTATE; // global and accessable from anywhere in our program
|
||||
|
||||
#endif
|
||||
|
||||
Reference in New Issue
Block a user