Kanda Foundation 0.2.0
Loading...
Searching...
No Matches
IAppLifecycleService Interface Reference

A service which handles application lifecycle, moving between lobby and sessions by loading scenes and instantiating relevant ECS worlds. More...

+ Inheritance diagram for IAppLifecycleService:

Public Member Functions

Task< AppLifecycleResultStartOfflineSession ()
 Instructs the application to start an offline session.
 
Task< AppLifecycleResultStartServerHostedSession ()
 Instructs the app to start a server-hosted session. This will be handled differently depending on whether the current platform is a client or a server.
 
Task< HostLanSessionResultHostLanSession ()
 Instructs application to start a self-hosted LAN session.
 
Task< AppLifecycleResultJoinLanSession (string hostIp)
 Instructs application to join a LAN session hosted by someone else.
 
Task< AppLifecycleResultGoToLobby ()
 Instructs application to go to the Lobby.
 

Properties

IStandardSceneService StandardScenes [get]
 

Detailed Description

A service which handles application lifecycle, moving between lobby and sessions by loading scenes and instantiating relevant ECS worlds.

Member Function Documentation

◆ GoToLobby()

Task< AppLifecycleResult > GoToLobby ( )

Instructs application to go to the Lobby.

Returns
True if the Lobby scene could be loaded.

Implemented in AppLifecycleService.

◆ HostLanSession()

Task< HostLanSessionResult > HostLanSession ( )

Instructs application to start a self-hosted LAN session.

Implemented in AppLifecycleService.

◆ JoinLanSession()

Task< AppLifecycleResult > JoinLanSession ( string hostIp)

Instructs application to join a LAN session hosted by someone else.

Parameters
hostIpThe local network IP of the host.

Implemented in AppLifecycleService.

◆ StartOfflineSession()

Task< AppLifecycleResult > StartOfflineSession ( )

Instructs the application to start an offline session.

Implemented in AppLifecycleService.

◆ StartServerHostedSession()

Task< AppLifecycleResult > StartServerHostedSession ( )

Instructs the app to start a server-hosted session. This will be handled differently depending on whether the current platform is a client or a server.

Implemented in AppLifecycleService.

Property Documentation

◆ StandardScenes

IStandardSceneService StandardScenes
get

Implemented in AppLifecycleService.


The documentation for this interface was generated from the following file: