ILocalPlayerInfoService Interface Reference

A service which stores local player information for consumption throughout the application lifecycle. More...

Inheritance diagram for ILocalPlayerInfoService:

Public Member Functions
void	SetName (string name)
	Updates the name of the local player.
void	SetSelectedRoomId (string roomId)
	Updates the selected room ID for the local player. This is set after selecting a session.
void	SetSelectedContentScene (ContentSceneMetadata contentScene)
	Updates the selected content scene for the local player. This is set after selecting a session.

Properties
string	Name [get]
	The name of the local player.
string	SelectedRoomId [get]
	The ID of the room which the user wishes to join.
ContentSceneMetadata	SelectedContentScene [get]
	Metadata about the content scene that the user wishes to enter.

Detailed Description

A service which stores local player information for consumption throughout the application lifecycle.

Member Function Documentation

SetName()

void SetName

(

string

name

)

Updates the name of the local player.

Implemented in LocalPlayerInfoService.

SetSelectedContentScene()

void SetSelectedContentScene

(

ContentSceneMetadata

contentScene

)

Updates the selected content scene for the local player. This is set after selecting a session.

Implemented in LocalPlayerInfoService.

SetSelectedRoomId()

void SetSelectedRoomId

(

string

roomId

)

Updates the selected room ID for the local player. This is set after selecting a session.

Implemented in LocalPlayerInfoService.

Property Documentation

Name

string Name

get

The name of the local player.

Implemented in LocalPlayerInfoService.

SelectedContentScene

ContentSceneMetadata SelectedContentScene

get

Metadata about the content scene that the user wishes to enter.

Implemented in LocalPlayerInfoService.

SelectedRoomId

string SelectedRoomId

get

The ID of the room which the user wishes to join.

Implemented in LocalPlayerInfoService.

---

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

• Runtime/Lifecycle/Services/LocalPlayerInfoService.cs