Class PlayerSessionCreationParams
The parameters used when creating a player session
Namespace: Unity.PSN.PS5.Sessions
Syntax
public class PlayerSessionCreationParamsProperties
Callbacks
Callbacks triggered when sWebApi notifications are recieved and processed by the session
Declaration
public PlayerSessionCallbacks Callbacks { get; set; }Property Value
| Type | Description |
|---|---|
| PlayerSessionCallbacks |
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[] |
ExclusiveLeaderPrivileges
Information about the items to exclude from the leader privileges of a Player Session If a specification is made with this parameter, the leader will not have the specified privileges.If nothing is specified, the leader will have all leader privileges All LeaderPrivilegeFlags are valid here.
Declaration
public LeaderPrivilegeFlags ExclusiveLeaderPrivileges { get; set; }Property Value
| Type | Description |
|---|---|
| LeaderPrivilegeFlags |
InvitableUserType
Information about who can send invitations to a Player Session
Declaration
public InvitableUserTypes InvitableUserType { get; set; }Property Value
| Type | Description |
|---|---|
| InvitableUserTypes |
Remarks
NoOne : No user can send an invite Leader : Only the leader can send invites Member : Any member can send invites
JoinableUserType
Users who can join Player Sessions without invitations
Declaration
public JoinableUserTypes JoinableUserType { get; set; }Property Value
| Type | Description |
|---|---|
| JoinableUserTypes |
Remarks
NoOne : No user can join without an invitation Friends : Friends of the leader of the Player Session can join FriendsOfFriends : Friends of friends of the leader of the Player Session can join Anyone : Anyone can join SpecifiedUsers : Users who have been registered on the joinableSpecifiedUsers list can join without invitations
JoinDisabled
Flag for temporarily prohibiting joining a Player Session. When true, the Player Session cannot be joined. When false, users who have received invitation notifications or users who can join without such notifications because of the value set for JoinableUserType can join the Player Session.
Declaration
public bool JoinDisabled { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |
LeaderPrivileges
If a specification is made with this parameter, the leader will have the specified privileges. If nothing is specified, the leader will have Kick and UpdateJoinableUserType privileges. However, it is recommended that ExclusiveLeaderPrivileges, rather than this parameter, be used to specify the leader's privileges. UpdateInvitableUerType flag will be ingorned for these privileges.
Declaration
public LeaderPrivilegeFlags LeaderPrivileges { get; set; }Property Value
| Type | Description |
|---|---|
| LeaderPrivilegeFlags |
LocalisedNames
Localisaed session names
Declaration
public LocalisedSessionNames LocalisedNames { get; set; }Property Value
| Type | Description |
|---|---|
| LocalisedSessionNames |
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 |
SessionFilters
The set of filters to use for the initial user who creates the session. Default to standard set of WebApi notification types. PlayerSessionFilters
Declaration
public WebApiFilters SessionFilters { get; set; }Property Value
| Type | Description |
|---|---|
| WebApiFilters |
SupportedPlatforms
Information about the platforms with which users can join a Player Session
Declaration
public SessionPlatforms SupportedPlatforms { get; set; }Property Value
| Type | Description |
|---|---|
| SessionPlatforms |
SwapSupported
Flag indicating whether members who have joined can switch from players to spectators, or from spectators to players, without leaving. When true, swapping is allowed. (Users can swap using the system software UI.)When false, swapping is not allowed
Declaration
public bool SwapSupported { get; set; }Property Value
| Type | Description |
|---|---|
| Boolean |