Class GameSession
Game session instance
Inherited Members
Namespace: Unity.PSN.PS5.Sessions
Syntax
public class GameSession : Session
Properties
MatchmakingOfferId
Information added by the Matchmaking service
Declaration
public string MatchmakingOfferId { get; }
Property Value
| Type | Description |
|---|---|
| String |
OnSessionUpdated
The session notification callback. Note that this type of update doesn't contain any data to the locally cached data doesn't reflect the change. This only notifies what type of data changed. Use PlayerSessionRequests.GetPlayerSessionsRequest to retieve the latest data about the session.
Declaration
public GameSession.SessionEventHandler OnSessionUpdated { get; set; }
Property Value
| Type | Description |
|---|---|
| GameSession.SessionEventHandler |
ReservationTimeoutSeconds
Period of validity for a reservation by a member to join a Game Session
Declaration
public int ReservationTimeoutSeconds { get; }
Property Value
| Type | Description |
|---|---|
| Int32 |
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; }
Property Value
| Type | Description |
|---|---|
| Boolean |
Methods
IsParamFlagSet(GameSession.ParamTypes, GameSession.ParamTypes)
Test is a flag is set
Declaration
public static bool IsParamFlagSet(GameSession.ParamTypes flags, GameSession.ParamTypes flagToCheck)
Parameters
| Type | Name | Description |
|---|---|---|
| GameSession.ParamTypes | flags | The session flags to check |
| GameSession.ParamTypes | flagToCheck | The session flag to test |
Returns
| Type | Description |
|---|---|
| Boolean | Returns true if the flag to check is set |
UpdateFrom(GameSessionRequests.RetrievedSessionData)
Update a game session from data retrieved from GameSessionRequests.GetGameSessionsRequest
Declaration
public void UpdateFrom(GameSessionRequests.RetrievedSessionData sessionData)
Parameters
| Type | Name | Description |
|---|---|---|
| GameSessionRequests.RetrievedSessionData | sessionData | The data to update |