TeamBalancer.h

Go to the documentation of this file.

#include "NativeFeatureIncludes.h"
#if _RAKNET_SUPPORT_TeamBalancer==1

#ifndef __TEAM_BALANCER_H
#define __TEAM_BALANCER_H

class RakPeerInterface;
#include "PluginInterface2.h"
#include "RakMemoryOverride.h"
#include "NativeTypes.h"
#include "DS_List.h"
#include "RakString.h"

namespace RakNet
{


typedef unsigned char TeamId;

#define UNASSIGNED_TEAM_ID 255

class RAK_DLL_EXPORT TeamBalancer : public PluginInterface2
{
public:
        TeamBalancer();
        virtual ~TeamBalancer();

        void SetHostGuid(RakNetGUID _hostGuid);

        void SetTeamSizeLimits(const DataStructures::List<unsigned short> &_teamLimits);

        void SetTeamSizeLimits(unsigned short *values, int valuesLength);
        
        enum DefaultAssigmentAlgorithm
        {
                SMALLEST_TEAM,
                FILL_IN_ORDER
        };
        void SetDefaultAssignmentAlgorithm(DefaultAssigmentAlgorithm daa);

        void SetForceEvenTeams(bool force);

        void SetLockTeams(bool lock);

        bool RequestSpecificTeam(TeamId desiredTeam);

        void CancelRequestSpecificTeam(void);

        void RequestAnyTeam(void);

        TeamId GetMyTeam(void) const;

        void SetAllowHostMigration(bool allow);

        struct TeamMember
        {
                RakNetGUID memberGuid;
                TeamId currentTeam;
                TeamId requestedTeam;
        };

protected:

        virtual PluginReceiveResult OnReceive(Packet *packet);
        virtual void OnClosedConnection(SystemAddress systemAddress, RakNetGUID rakNetGUID, PI2_LostConnectionReason lostConnectionReason );

        void OnStatusUpdateToNewHost(Packet *packet);
        void OnCancelTeamRequest(Packet *packet);
        void OnRequestAnyTeam(Packet *packet);
        void OnRequestSpecificTeam(Packet *packet);

        RakNetGUID hostGuid;
        TeamId currentTeam;
        TeamId requestedTeam;
        DefaultAssigmentAlgorithm defaultAssigmentAlgorithm;
        bool forceTeamsToBeEven;
        bool lockTeams;
        bool expectingToReceiveTeamNumber; // So if we lose the connection while processing, we request the same info of the new host
        bool allowHostMigration;

        DataStructures::List<unsigned short> teamLimits;
        DataStructures::List<unsigned short> teamMemberCounts;
        DataStructures::List<TeamMember> teamMembers;
        unsigned int GetMemberIndex(RakNetGUID guid);
        unsigned int AddTeamMember(const TeamMember &tm); // Returns index of new member
        void RemoveTeamMember(unsigned int index);
        void EvenTeams(void);
        unsigned int GetMemberIndexToSwitchTeams(const DataStructures::List<TeamId> &sourceTeamNumbers, TeamId targetTeamNumber);
        void GetOverpopulatedTeams(DataStructures::List<TeamId> &overpopulatedTeams, int maxTeamSize);
        void SwitchMemberTeam(unsigned int teamMemberIndex, TeamId destinationTeam);
        void NotifyTeamAssigment(unsigned int teamMemberIndex);
        bool WeAreHost(void) const;
        PluginReceiveResult OnTeamAssigned(Packet *packet);
        PluginReceiveResult OnRequestedTeamChangePending(Packet *packet);
        PluginReceiveResult OnTeamsLocked(Packet *packet);
        void GetMinMaxTeamMembers(int &minMembersOnASingleTeam, int &maxMembersOnASingleTeam);
        TeamId GetNextDefaultTeam(void); // Accounting for team balancing and team limits, get the team a player should be placed on
        bool TeamWouldBeOverpopulatedOnAddition(TeamId teamId, unsigned int teamMemberSize); // Accounting for team balancing and team limits, would this team be overpopulated if a member was added to it?
        bool TeamWouldBeUnderpopulatedOnLeave(TeamId teamId, unsigned int teamMemberSize);
        TeamId GetSmallestNonFullTeam(void) const;
        TeamId GetFirstNonFullTeam(void) const;
        void MoveMemberThatWantsToJoinTeam(TeamId teamId);
        TeamId MoveMemberThatWantsToJoinTeamInternal(TeamId teamId);
        void NotifyTeamsLocked(RakNetGUID target, TeamId requestedTeam);
        void NotifyTeamSwitchPending(RakNetGUID target, TeamId requestedTeam);
        void NotifyNoTeam(RakNetGUID target);
        void SwapTeamMembersByRequest(unsigned int memberIndex1, unsigned int memberIndex2);
        void RemoveByGuid(RakNetGUID rakNetGUID);
        bool TeamsWouldBeEvenOnSwitch(TeamId t1, TeamId t2);

};

} // namespace RakNet

#endif

#endif // _RAKNET_SUPPORT_*