 | RuyiSDK Class |
[This is preliminary documentation and is subject to change.]
The main class used to communicate with the Ruyi platform.
Inheritance HierarchyNamespace: Ruyi
Assembly: RuyiSDK (in RuyiSDK.dll) Version: 0.9.3.3995 (0.9.3.3995)
SyntaxC#
public class RuyiSDK : IDisposable
The RuyiSDK type exposes the following members.
Properties| Name | Description | |
|---|---|---|
 | InputMgr |
Input-related services
|
| L10NService |
Localization service
|
| Media |
Multimedia-related services
|
| OverlayService |
the overlay service
|
| RuyiNetService |
Online functionality
|
| SettingSys |
Setting system
|
| SpeechService |
Speech service
|
 | Storage |
Storage service
|
| Subscriber |
To subscribe to published topics.
|
| UserService |
User-related services
|
Methods| Name | Description | |
|---|---|---|
  | CreateInstance |
Create a new SDK instance with the given context.
|
| Dispose |
Dispose the SDK instance, don't miss this after SDK usage.
|
| Update |
Update loop for all service clients that need it.
|
RemarksUpdate must be called periodically (e.g. each frame) for all service clients to function correctly.
Examplesvar sdkCtx = new RuyiSDKContext { endpoint = RuyiSDKContext.Endpoint.Console, EnabledFeatures = RuyiSDK.SDKFeatures.All }; using (var sdk = RuyiSDK.CreateInstance(sdkCtx)) { while (IsGameRunning()) { sdk.Update(); } }
See Also