MatchmakingService

Provides leaderboard relayed functions that manage 1:1 matchmaking and win/loss results.

# Methods

[{"index":"MatchmakingResultCode CancelMatchingAndWait(string userProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Cancels matchmaking. Returns the result codes when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, LeaderboardInfo CreateLeaderboardAndWait(string name, LeaderboardScoringStrategy scoringStrategy, LeaderboardRatingStrategy ratingStrategy, LeaderboardRankingStrategy rankingStrategy, LeaderboardSeasonResetInfo resetInfo) (ServerOnly) (ReleaseOnly) (Yield)","0":"Creates a leaderboard. You can create up to 20 leaderboards per world, and each leaderboard can save up to the 30 most recent seasons.If ratingStrategy is None, only the scores will be registered to the leaderboard and the rankings will not be calculated.The ratingStrategy needs to be set as a value other than None to calculate rankings, and if so, scoringStrategy must be set to Last.If resetInfo is nil, the leaderboard isn't reset and will function with only a single season.Returns the results code and the created leaderboard when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode DeleteLeaderboardAndWait(string leaderboardId) (ServerOnly) (ReleaseOnly) (Yield)","0":"Deletes the leaderboard. Returns the result codes when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode DeleteScoreInfoAndWait(string leaderboardId, string userProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Deletes the user's score. Returns the results code when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, LeaderboardInfo GetLeaderboardInfoAndWait(string leaderboardId) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads leaderboard information. Returns the results code and leaderboard information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, table GetLeaderboardInfosAndWait() (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads all of the world's leaderboard information.Returns the results code and leaderboard information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"MatchmakingResultCode, table GetMatchUserInfosAndWait(string userProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the information of users that have been successfully matchmade.The first element of the table is the Home user, and the second element is the Away user.Returns the results code and user information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, LeaderboardRankInfo GetRankInfoAndWait(string leaderboardId, string seasonId, string userProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the user's ranking information.Returns the results code and ranking information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, table GetRankInfosAndWait(string leaderboardId, string seasonId, int32 startRank, int32 count) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the user's ranking information within a set range.startRank is the starting rank for the inquiry, while count is the number of rankings in the inquiry. You can inquire up to 100 at once.Returns the results code and ranking information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, LeaderboardScoreInfo GetScoreInfoAndWait(string leaderboardId, string seasonId, string userProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the user's score information.Returns the results code and score information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, LeaderboardSeasonInfo GetSeasonInfoAndWait(string leaderboardId, string seasonId) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the information for a specific leaderboard season.Returns the results code and season information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode, table GetSeasonInfosAndWait(string leaderboardId) (ServerOnly) (ReleaseOnly) (Yield)","0":"Loads the information for all leaderboard seasons.Returns the results code and season information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"MatchmakingResultCode RequestMatchingAndWait(string leaderBoardId, string queueName, string userProfileCode, string extras, func onCompleted) (ServerOnly) (ReleaseOnly) (Yield)","0":"Requests matchmaking. Matchmaking occurs only between users with the same queueName.Calls the match information and the function that was delivered to onCompleted when matchmaking is successful or not. Script executions are suspended during the operation."}]

[{"index":"LeaderboardResultCode SetScoreAndWait(string leaderboardId, string userProfileCode, int32 score, string extras) (ServerOnly) (ReleaseOnly) (Yield)","0":"Registers a user's score and updates the ranking.The extras info is random data that can be additionally saved based on need.Returns the results code when the process is complete. Script executions are suspended during the operation."}]

[{"index":"MatchmakingResultCode, MatchResultInfo UpdateMatchResultAndWait(string leaderboardId, string homeUserProfileCode, string awayUserProfileCode, string winnerUserProfileCode) (ServerOnly) (ReleaseOnly) (Yield)","0":"Newly calculates the scores by applying the win or loss from the match. Delivers nil to winnerUserProfileCode in the case of a draw.Returns the results code and match result information when the process is complete. Script executions are suspended during the operation."}]

[{"index":"MatchmakingResultCode WarpMatchUser(string userProfileCode) (ServerOnly) (ReleaseOnly)","0":"Warps users that have been matchmade to the same world instance and returns the results code."}]

##### inherited from Service:

[{"index":"EventHandlerBase ConnectEvent(string key, IScriptFunction eventHandler)","0":"Links events. When a key-type event occurs in this service, a handler is notified. The handler receives event parameters."}]

[{"index":"EventHandlerBase ConnectEvent(Type eventType, IScriptFunction eventHandler)","0":"Links events. This service notifies a handler when an eventType event occurs. The handler receives event parameters."}]

[{"index":"boolean DisconnectEvent(string key, EventHandlerBase eventHandler)","0":"Disconnects the event with the key-type event and the handler."}]

[{"index":"boolean DisconnectEvent(Type eventType, EventHandlerBase eventHandler)","0":"Disconnects the eventType event from its handler."}]

[{"index":"void SendEvent(EventType sendEvent)","0":"Generates an event."}]