Class BaseSatellite
Base class for the satellite actor. Extend your satellite actor from this class.
Call Init(SatelliteReceiver) to initialize the actor.
Namespace: STREAMSIX.Actor.Satellite
Assembly: cs.temp.dll.dll
Syntax
public abstract class BaseSatellite : RMBActor
Fields
SourceApplication
Name of this application. Usually this is name of the game's actor. Add a suffix to indicate this is mothership.
Declaration
public string SourceApplication
Field Value
| Type | Description |
|---|---|
| System.String |
SourceVersion
Version of this application.
Declaration
public string SourceVersion
Field Value
| Type | Description |
|---|---|
| System.String |
Properties
Instance
Convenient singleton instance. There should only be one satellite running in Editor.
Declaration
public static BaseSatellite Instance { get; }
Property Value
| Type | Description |
|---|---|
| BaseSatellite |
Methods
Init(SatelliteReceiver)
Setups config, logger, and various remote clients. Then returns the satellite Handler.
In Editor, this function waits for rmb to spawn and connects to actor before returning.
Declaration
protected async Task<SatelliteSender> Init(SatelliteReceiver satHandler)
Parameters
| Type | Name | Description |
|---|---|---|
| SatelliteReceiver | satHandler | Your satellite class for receiving messages. |
Returns
| Type | Description |
|---|---|
| System.Threading.Tasks.Task<SatelliteSender> | Satellite handler for sending out messages. |
SpawnRequest(SpawningInfo)
Declaration
public void SpawnRequest(SpawningInfo game)
Parameters
| Type | Name | Description |
|---|---|---|
| SpawningInfo | game |
StopRequest()
Declaration
public void StopRequest()