Class GameSessionCreationParams
The parameters used when creating a game session
Namespace: Unity.PSN.PS5.Sessions
Syntax
public class GameSessionCreationParams
Fields
AdditionalMembers
Additional members to add to the game session
Declaration
public List<GameSessionInitMember> AdditionalMembers
Field Value
| Type | Description |
|---|---|
| List<GameSessionInitMember> |
Properties
Callbacks
Callbacks triggered when WebApi notifications are recieved and processed by the session
Declaration
public GameSessionCallbacks Callbacks { get; set; }
Property Value
| Type | Description |
|---|---|
| GameSessionCallbacks |
CustomData1
Custom data. The maximum size is the size yielded from encoding 1024 bytes in Base64.
Declaration
public byte[] CustomData1 { get; set; }
Property Value
| Type | Description |
|---|---|
| Byte[] |
CustomData2
Custom data. The maximum size is the size yielded from encoding 1024 bytes in Base64.
Declaration
public byte[] CustomData2 { get; set; }
Property Value
| Type | Description |
|---|---|
| Byte[] |
JoinDisabled
Flag for temporarily prohibiting joining a Game Session. When true, the Game Session cannot be joined.
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 |
ReservationTimeoutSeconds
Period of validity for a reservation by a member to join a Game Session
Declaration
public int ReservationTimeoutSeconds { get; set; }
Property Value
| Type | Description |
|---|---|
| Int32 |
SessionFilters
The set of filters to use for the initial user who creates the session. Default to standard set of WebApi notification types. GameSessionFilters
Declaration
public WebApiFilters SessionFilters { get; set; }
Property Value
| Type | Description |
|---|---|
| WebApiFilters |
SupportedPlatforms
Information about the platforms with which users can join a Game Session
Declaration
public SessionPlatforms SupportedPlatforms { get; set; }
Property Value
| Type | Description |
|---|---|
| SessionPlatforms |
UsePlayerSession
Flag that indicates Game Session and Player Session dependency true indicates an association with a Player Session, and false indicates a standalone Game Session. Defaults true
Declaration
public bool UsePlayerSession { get; set; }
Property Value
| Type | Description |
|---|---|
| Boolean |