Class GameSessionRequests.SetGameSessionPropertiesRequest
Update Game Session information
Namespace: Unity.PSN.PS5.Sessions
Syntax
public class SetGameSessionPropertiesRequest : Request
Remarks
Modify one item of information specified, out of all the information concerning the Game Session (it is not possible to update multiple items, and specifying multiple such items will result in an error). If MaxPlayers is being updated, it cannot be modified to a value smaller than the number of players already currently participating. If MaxSpectators is being updated, it cannot be modified to a value smaller than the number of spectators already currently participating.
Properties
CustomData1
Custom binary session data
Declaration
public byte[] CustomData1 { get; set; }
Property Value
| Type | Description |
|---|---|
| Byte[] |
CustomData2
Custom binary session data
Declaration
public byte[] CustomData2 { get; set; }
Property Value
| Type | Description |
|---|---|
| Byte[] |
JoinDisabled
Flag that temporarily prohibits joining a Game Session.
Declaration
public bool JoinDisabled { get; set; }
Property Value
| Type | Description |
|---|---|
| Boolean |
MaxPlayers
Maximum number of supported players. Min 1, Max 100
Declaration
public uint MaxPlayers { get; set; }
Property Value
| Type | Description |
|---|---|
| UInt32 |
MaxSpectators
Maximum number of supported spectators. Min 0, Max 50
Declaration
public uint MaxSpectators { get; set; }
Property Value
| Type | Description |
|---|---|
| UInt32 |
ParamToSet
Which parameters should be set. Only one item can be set at a time, specifying multiple such items will result in an error
Declaration
public GameSession.ParamTypes ParamToSet { get; set; }
Property Value
| Type | Description |
|---|---|
| GameSession.ParamTypes |
SessionId
Session id to update
Declaration
public string SessionId { get; set; }
Property Value
| Type | Description |
|---|---|
| String |
UserId
User ID
Declaration
public int UserId { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
Methods
Run()
Declaration
protected override void Run()