Manage properties as a client
Manage your sessions with the operations available to you as a session client.
阅读时间2 分钟最后更新于 4 个月前
As a session client, you have access to operations that let you interact with session and player properties.
Note that some client operations differ from those available to the host.
Session property operations
A client can read properties from a session. Unlike a host, a client can't add, update, or delete session properties.
注意
If you are the host and have an (client session), you can call to get an (host session) from your .
After you have an , you can add, update, or delete session property. Refer to Session operations as a host.
ISessionISession.AsHost()IHostSessionISessionIHostSessionRead APIs
The following APIs allow a client to read session properties:
ISession.IReadOnlyDictionary<string, SessionProperty> Properties { get; }
Read a session property
The following code snippet demonstrates how to read the property:
colourif (clientSession.Properties.TryGetValue("colour", out var colour)){ Debug.Log($"The colour session property is {colour.Value}");}
Player property operations
A client can access any player properties set as visible to them. However, a client can only add, update, or remove the player properties they own.
Read APIs
The following APIs allow a client to read player properties:
IPlayer ISession.CurrentPlayer { get; }IReadOnlyList<IReadOnlyPlayer> ISession.Players { get; }
注意
Use to read your own properties.
ISession.CurrentPlayerRead a player property
The following code snippet demonstrates how to read the player property:
colourif (clientSession.Players.First().Properties.TryGetValue("colour", out var colour)){ Debug.Log($"First player colour property is {colour.Value}");}
Write APIs
The following APIs allow a client to modify its player properties:
IPlayer ISession.CurrentPlayer { get; }Task ISession.SaveCurrentPlayerDataAsync();void IPlayer.SetProperty(string key, PlayerProperty property);void IPlayer.SetProperties(Dictionary<string, PlayerProperty> properties);
Add a player property
To add a property, decide upon the visibility of the property:
- Public (visible to everyone)
- Member (visible to members of the Session)
- Private (visible to the player who owns the property and the host)
The following code snippet demonstrates how to add a property with the value on a client:
colourredvar redColourProperty = new PlayerProperty("red");clientSession.CurrentPlayer.SetProperty("colour", redColourProperty);await clienSession.SaveCurrentPlayerDataAsync();
Update a player property
The following code snippet demonstrates how to set the property to on a client:
colournullvar nullColourProperty = new PlayerProperty(null);clientSession.CurrentPlayer.SetProperty("colour", redColourProperty);await clienSession.SaveCurrentPlayerDataAsync();
Delete a player property
The following code snippet demonstrates how to delete the property on a client:
colourclientSession.CurrentPlayer.SetProperty("colour", null);await clienSession.SaveCurrentPlayerDataAsync();