CTR Pia
4.11.3
Game Communication Engine
|
The search condition class used when searching for a session. More...
Public Member Functions | |
NexSessionSearchCriteria () | |
The default constructor. | |
virtual | ~NexSessionSearchCriteria () |
The destructor. | |
NexSessionSearchCriteria & | operator= (const NexSessionSearchCriteria &r) |
Assignment operator. More... | |
void | SetAttribute (u32 index, u32 value) |
Sets a value to use when searching for a single attribute. More... | |
void | SetAttribute (u32 index, u32 *value, size_t attributeNum) |
Sets multiple values to use when searching for a single attribute. More... | |
void | SetAttributeRange (u32 index, u32 min, u32 max) |
Sets a range of values to use when searching for a single attribute. More... | |
void | SetCommunityId (u32 gid) |
Sets the ID for the associated community (persistent gathering). | |
void | SetDisconnectionRate (u32 disconnectionRate) |
Sets the disconnection rate to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
void | SetExcludeNonHostPid (bool bExclude) |
Sets whether to exclude sessions with no hosts from the search. (By default, they are excluded.) More... | |
void | SetExcludeUserPasswordSet (bool bExclude) |
Sets whether to exclude sessions for which a user password was set from the search. (By default, they are excluded.) More... | |
void | SetGameMode (u32 gameMode) |
Sets the search conditions to game mode. More... | |
void | SetMaxParticipants (u16 max) |
Sets the maximum participants in the search criteria. More... | |
void | SetMaxParticipantsRange (u16 min, u16 max) |
Sets a range of maximum participants in the search criteria. More... | |
void | SetMinParticipants (u16 min) |
Sets the minimum participants in the search criteria. More... | |
void | SetMinParticipantsRange (u16 min, u16 max) |
Sets a range of minimum participants in the search criteria. More... | |
void | SetNintendoCountryCode (u32 countryCode) |
Sets the country code to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
void | SetOpenedOnly (bool bOpenedOnly) |
Sets whether to search only for sessions that are open to participants in the search criteria. More... | |
void | SetOverrideIpAddress (const wchar_t *pIpAddress, size_t ipAddressLength) |
Sets the IP address for debugging to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
void | SetRandomSessionSelectionMethod (SelectionMethod selectionMethod) |
Sets the selection methods for joining sessions when random matchmaking is in effect. More... | |
void | SetRatingValue (u32 ratingValue) |
Sets the rating value to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
virtual void | SetResultRange (u32 offset, u32 size) |
Specifies the range of search results to get. More... | |
void | SetScoreSettingIndex (u32 settingIndex) |
Sets the setting index for the score calculation method to use during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
void | SetSessionType (SessionType sessionType) |
Sets the session type search conditions. More... | |
void | SetUseGeoIp (bool b) |
Sets whether to use position information (longitude and latitude, country code) for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
void | SetVacantOnly (bool bVacantOnly) |
Sets whether to search only for sessions that have openings in the search criteria. More... | |
void | SetViolationRate (u32 violationRate) |
Sets the violation rate to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED . More... | |
The search condition class used when searching for a session.
2015-03-20 Added APIs to set parameters for scored matchmaking.
2014-02-03 Initial version.
NexSessionSearchCriteria& nn::pia::inet::NexSessionSearchCriteria::operator= | ( | const NexSessionSearchCriteria & | r | ) |
Assignment operator.
[in] | r | The object to assign. |
void nn::pia::inet::NexSessionSearchCriteria::SetAttribute | ( | u32 | index, |
u32 | value | ||
) |
Sets a value to use when searching for a single attribute.
[in] | index | Specifies the index of an attribute. |
[in] | value | Specifies the value of an attribute. |
void nn::pia::inet::NexSessionSearchCriteria::SetAttribute | ( | u32 | index, |
u32 * | value, | ||
size_t | attributeNum | ||
) |
Sets multiple values to use when searching for a single attribute.
[in] | index | Specifies the index of an attribute. |
[in] | value | Specifies a list of values for an attribute. |
[in] | attributeNum | Specifies the number of values for an attribute. |
void nn::pia::inet::NexSessionSearchCriteria::SetAttributeRange | ( | u32 | index, |
u32 | min, | ||
u32 | max | ||
) |
Sets a range of values to use when searching for a single attribute.
[in] | index | Specifies the index of an attribute. |
[in] | min | Specifies the minimum value of an attribute. |
[in] | max | Specifies the maximum value of an attribute. |
void nn::pia::inet::NexSessionSearchCriteria::SetDisconnectionRate | ( | u32 | disconnectionRate | ) |
Sets the disconnection rate to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
When not set, the score for the disconnection rate difference uses a default score to rate. We recommend using NEX's MatchmakeReferee
feature.
[in] | disconnectionRate | Specifies the disconnection rate. |
void nn::pia::inet::NexSessionSearchCriteria::SetExcludeNonHostPid | ( | bool | bExclude | ) |
Sets whether to exclude sessions with no hosts from the search. (By default, they are excluded.)
[in] | bExclude | Specifies whether to exclude sessions with no hosts from the search. Set to true to enable. |
void nn::pia::inet::NexSessionSearchCriteria::SetExcludeUserPasswordSet | ( | bool | bExclude | ) |
Sets whether to exclude sessions for which a user password was set from the search. (By default, they are excluded.)
[in] | bExclude | Specifies whether to exclude sessions for which a user password was set from the search. Set to true to enable. |
void nn::pia::inet::NexSessionSearchCriteria::SetGameMode | ( | u32 | gameMode | ) |
Sets the search conditions to game mode.
When no search conditions are set, it matches the game mode of any value.
[in] | gameMode | Specifies the game mode search conditions. |
void nn::pia::inet::NexSessionSearchCriteria::SetMaxParticipants | ( | u16 | max | ) |
Sets the maximum participants in the search criteria.
[in] | max | The maximum participants value to set in the search criteria. |
void nn::pia::inet::NexSessionSearchCriteria::SetMaxParticipantsRange | ( | u16 | min, |
u16 | max | ||
) |
Sets a range of maximum participants in the search criteria.
[in] | min | The minimum value of the range to set for maximum participants in the search criteria. |
[in] | max | The maximum value of the range to set for maximum participants in the search criteria. |
void nn::pia::inet::NexSessionSearchCriteria::SetMinParticipants | ( | u16 | min | ) |
Sets the minimum participants in the search criteria.
[in] | min | The minimum participants value to set in the search criteria. |
void nn::pia::inet::NexSessionSearchCriteria::SetMinParticipantsRange | ( | u16 | min, |
u16 | max | ||
) |
Sets a range of minimum participants in the search criteria.
[in] | min | The minimum value of the range to set for minimum participants in the search criteria. |
[in] | max | The maximum value of the range to set for minimum participants in the search criteria. |
void nn::pia::inet::NexSessionSearchCriteria::SetNintendoCountryCode | ( | u32 | countryCode | ) |
Sets the country code to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
Sets the country code to use when you have configured to not use location information with UseGeoIP()
or when you have configured to use that location information but it was not available. The specified country code is not used when location information is available. When a country code is not set, and when you have configured to not use location information with UseGeoIP()
or when you have configured to use that location information but it was not available, the default value is used as the score for comparing country codes.
[in] | countryCode | Specifies the country code. |
void nn::pia::inet::NexSessionSearchCriteria::SetOpenedOnly | ( | bool | bOpenedOnly | ) |
Sets whether to search only for sessions that are open to participants in the search criteria.
[in] | bOpenedOnly | Specify true to search only for sessions that are open to participants. |
void nn::pia::inet::NexSessionSearchCriteria::SetOverrideIpAddress | ( | const wchar_t * | pIpAddress, |
size_t | ipAddressLength | ||
) |
Sets the IP address for debugging to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
Use this IP address instead of your own to get location information using GeoIP
. Only available for debugging.
[in] | pIpAddress | Specifies the replacement IP address. |
[in] | ipAddressLength | Specifies the IP address string length. |
void nn::pia::inet::NexSessionSearchCriteria::SetRandomSessionSelectionMethod | ( | SelectionMethod | selectionMethod | ) |
Sets the selection methods for joining sessions when random matchmaking is in effect.
[in] | selectionMethod | Specifies the selection method to set for the session. |
void nn::pia::inet::NexSessionSearchCriteria::SetRatingValue | ( | u32 | ratingValue | ) |
Sets the rating value to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
When not set, the score for the rating value difference uses a default score to rate.
[in] | ratingValue | Specifies the rating value. |
|
inlinevirtualinherited |
Specifies the range of search results to get.
If you specify 0xFFFFFFFF
for the offset only during Internet communication, the search results will be sorted randomly and it will get the specified number of entries.
[in] | offset | Starting position of the entries to get as search results from the list of entries that match the search criteria. |
[in] | size | Number of entries to get as search results from the list of entries that match the search criteria. |
void nn::pia::inet::NexSessionSearchCriteria::SetScoreSettingIndex | ( | u32 | settingIndex | ) |
Sets the setting index for the score calculation method to use during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
0
is used when a setting index is not set.
[in] | settingIndex | Specifies the score calculation setting index. |
void nn::pia::inet::NexSessionSearchCriteria::SetSessionType | ( | SessionType | sessionType | ) |
Sets the session type search conditions.
If no conditions are specified, the default value (SESSION_TYPE_ANYBODY
) will be used.
[in] | sessionType | Specifies the session type search conditions. |
void nn::pia::inet::NexSessionSearchCriteria::SetUseGeoIp | ( | bool | b | ) |
Sets whether to use position information (longitude and latitude, country code) for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
When not setting whether to use position information, the score for comparing distance uses the default score for rating.
[in] | b | Specifies whether to use position information. |
void nn::pia::inet::NexSessionSearchCriteria::SetVacantOnly | ( | bool | bVacantOnly | ) |
Sets whether to search only for sessions that have openings in the search criteria.
[in] | bVacantOnly | Specify true to search only for sessions that have openings. |
void nn::pia::inet::NexSessionSearchCriteria::SetViolationRate | ( | u32 | violationRate | ) |
Sets the violation rate to use for comparison during nn::pia::inet::SELECTION_METHOD_SCORE_BASED
.
When not set, the score for the violation rate difference uses a default score to rate. We recommend using NEX's MatchmakeReferee
feature.
[in] | violationRate | Specifies the violation rate. |