 | RuyiNetClient Class |
[This is preliminary documentation and is subject to change.]
The main client for accessing Ruyi's online services (aka "RuyiNet")
Inheritance HierarchyNamespace: Ruyi.SDK.Online
Assembly: SDK.RuyiSDKAsync (in SDK.RuyiSDKAsync.dll) Version: 0.9.3.3995
SyntaxC#
public class RuyiNetClient : IDisposable
The RuyiNetClient type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | ActivePlayer |
Returns the first active player available.
|
| ActivePlayerIndex |
Returns the index of the first active player available.
|
| CloudService |
Handles backing up data to the cloud.
|
| CurrentPlayers |
The profile of the currently logged in player, if any.
|
| FriendService |
Provides operations for managing Friend Lists.
|
| GamificationService | |
| Initialised |
Whether or not RuyiNet has been initialised.
|
| LeaderboardService |
Provides operations to retrieve leaderboard data and submit scores.
|
| LobbyService |
Manages lobbies for network games.
|
| NewUser |
Whether or not this player is a new user.
|
| PartyService |
Allows players to gather together in a party.
|
| PatchService |
Get manifest info for a game.
|
| ProfileService |
Allows users to upload files to their individual accounts
|
| RemoteIpAddress |
The remote IP address that can be used to connect to this machine.
|
| TelemetryService |
Handles pushing telemetry data to the cloud.
|
| UserFileService |
Allows users to upload files to their individual accounts
|
| VideoService |
Allows users to upload videos to their individual accounts.
|
Methods| Name | Description | |
|---|---|---|
 | Dispose |
Cleanup native resources before destruction.
|
| Initialise |
Initialise the RUYI net client and switch to the game context.
|
RemarksInstance available from RuyiNetService property of RuyiSDK.
Must call [!:RuyiNetClient.Update] periodically to process events and callbacks.
Examplesusing (var ruyi = RuyiSDK.CreateInstance(new RuyiSDKContext { endpoint = RuyiSDKContext.Endpoint.Console })) { ruyi.RuyiNetService.Initialise(APP_ID, APP_SECRET, () => { foreach (var player in ruyi.RuyiNetService.CurrentPlayers) { if (player == null) continue; Console.WriteLine(player.profileName); } }); while (ruyi.RuyiNetService.IsWorking) { ruyi.Update(); } }
See Also