TeamBalancer.h

Go to the documentation of this file.

/*
 *  Original work: Copyright (c) 2014, Oculus VR, Inc.
 *  All rights reserved.
 *
 *  This source code is licensed under the BSD-style license found in the
 *  RakNet License.txt file in the licenses directory of this source tree. An additional grant 
 *  of patent rights can be found in the RakNet Patents.txt file in the same directory.
 *
 *
 *  Modified work: Copyright (c) 2017, SLikeSoft UG (haftungsbeschränkt)
 *
 *  This source code was modified by SLikeSoft. Modifications are licensed under the MIT-style
 *  license found in the license.txt file in the root directory of this source tree.
 */



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

#ifndef __TEAM_BALANCER_H
#define __TEAM_BALANCER_H

#include "PluginInterface2.h"
#include "memoryoverride.h"
#include "NativeTypes.h"
#include "DS_List.h"
#include "string.h"

namespace SLNet
{
class RakPeerInterface;


typedef unsigned char TeamId;

#define UNASSIGNED_TEAM_ID 255

class RAK_DLL_EXPORT TeamBalancer : public PluginInterface2
{
public:
    // GetInstance() and DestroyInstance(instance*)
    STATIC_FACTORY_DECLARATIONS(TeamBalancer)

    TeamBalancer();
    virtual ~TeamBalancer();

    void SetTeamSizeLimit(TeamId team, unsigned short limit);

    enum DefaultAssigmentAlgorithm
    {
        SMALLEST_TEAM,
        FILL_IN_ORDER
    };
    void SetDefaultAssignmentAlgorithm(DefaultAssigmentAlgorithm daa);

    void SetForceEvenTeams(bool force);

    void SetLockTeams(bool lock);

    void RequestSpecificTeam(NetworkID memberId, TeamId desiredTeam);

    void CancelRequestSpecificTeam(NetworkID memberId);

    void RequestAnyTeam(NetworkID memberId);

    TeamId GetMyTeam(NetworkID memberId) const;

    void DeleteMember(NetworkID memberId);

    struct TeamMember
    {
        RakNetGUID memberGuid;
        NetworkID memberId;
        TeamId currentTeam;
        TeamId requestedTeam;
    };
    struct MyTeamMembers
    {
        NetworkID memberId;
        TeamId currentTeam;
        TeamId requestedTeam;
    };

protected:

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

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

    RakNetGUID hostGuid;
    DefaultAssigmentAlgorithm defaultAssigmentAlgorithm;
    bool forceTeamsToBeEven;
    bool lockTeams;
    // So if we lose the connection while processing, we request the same info of the new host
    DataStructures::List<MyTeamMembers> myTeamMembers;

    DataStructures::List<unsigned short> teamLimits;
    DataStructures::List<unsigned short> teamMemberCounts;
    DataStructures::List<TeamMember> teamMembers;
    unsigned int GetMemberIndex(NetworkID memberId, RakNetGUID guid) const;
    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, NetworkID memberId);
    void NotifyNoTeam(NetworkID memberId, RakNetGUID target);
    void SwapTeamMembersByRequest(unsigned int memberIndex1, unsigned int memberIndex2);
    void RemoveByGuid(RakNetGUID rakNetGUID);
    bool TeamsWouldBeEvenOnSwitch(TeamId t1, TeamId t2);

};

} // namespace SLNet

#endif

#endif // _RAKNET_SUPPORT_*