nn::nex::MatchmakeSession::SetMatchmakeSystemType Member Function

Syntax

void SetMatchmakeSystemType(
     MatchmakeSystemType matchmakeSystemType,
     qUnsignedInt32 policyArgument = 0
);

Parameters

Name Description
in matchmakeSystemType Matchmaking system type.
in policyArgument Policy argument. (The default value is 0.)

Return Values

None.

Description

Sets the matchmaking system type.

Sets the matchmaking system type of the matchmaking session.

Matchmaking sessions for which MATCHMAKE_SYSTEM_TYPE_FRIEND is specified for matchmakeSystemType are restricted so that only friends can join. If GatheringFlags::MigrateOwner has been set using the Gathering::SetFlag function, the gathering is automatically closed when the owner leaves the matchmaking session and ownership is automatically transferred to another player. However, the gathering is not automatically closed when specifying FriendOnlyParticipationPolicyArgument::WithoutClose for policyArgument.

Matchmaking sessions for which MATCHMAKE_SYSTEM_TYPE_ANYBODY is specified for matchmakeSystemType can be joined by anybody. If GatheringFlags::MigrateOwner has been set using the Gathering::SetFlag function, the gathering will not be automatically closed even if the owner leaves the matchmaking session and ownership is transferred to another player. However, if you specify AnybodyParticipationPolicyArgument::CloseOnOwnerMigration for policyArgument, the gathering automatically closes when owner migration occurs.

policyArgument is ignored when anything other than MATCHMAKE_SYSTEM_TYPE_FRIEND or MATCHMAKE_SYSTEM_TYPE_ANYBODY is specified for matchmakeSystemType.

When MATCHMAKE_SYSTEM_TYPE_PERSISTENT_GATHERING or MATCHMAKE_SYSTEM_TYPE_COMMUNITY is specified for matchmakeSystemType, the gathering ID of the persistent gathering or the community must be set for the 0th attribute value using the SetAttribute function.

Revision History

2014/09/17
Added an option for automatically closing a gathering when matchmakeSystemType is MATCHMAKE_SYSTEM_TYPE_ANYBODY by specifying a particular value for policyArgument.
2013/03/26
Revised the description of matchmakeSystemType.
2011/01/27
Initial version.

CONFIDENTIAL