Class UISessionEntry

Namespace

PlayEveryWare.EpicOnlineServices.Samples

public class UISessionEntry : MonoBehaviour

Inheritance

object

UISessionEntry

Fields

EndButton

public Button EndButton

Field Value

Button

EndOnClick

public Action<string> EndOnClick

Field Value

Action<string>

InvitesTxt

public Text InvitesTxt

Field Value

Text

JIPTxt

public Text JIPTxt

Field Value

Text

JoinButton

public Button JoinButton

Field Value

Button

JoinOnClick

public Action<SessionDetails> JoinOnClick

Field Value

Action<SessionDetails>

JoinSessionDetails

public SessionDetails JoinSessionDetails

Field Value

SessionDetails

LeaveButton

public Button LeaveButton

Field Value

Button

LeaveOnClick

public Action<string> LeaveOnClick

Field Value

Action<string>

LevelTxt

public Text LevelTxt

Field Value

Text

ModifyButton

public Button ModifyButton

Field Value

Button

ModifyOnClick

public Action<string> ModifyOnClick

Field Value

Action<string>

NameTxt

public Text NameTxt

Field Value

Text

PermissionTxt

public Text PermissionTxt

Field Value

Text

PlayersTxt

public Text PlayersTxt

Field Value

Text

StartButton

public Button StartButton

Field Value

Button

StartOnClick

public Action<string> StartOnClick

Field Value

Action<string>

StatusTxt

public Text StatusTxt

Field Value

Text

Properties

RepresentedSession

public Session RepresentedSession { get; set; }

Property Value

Session

Methods

EnableButtonsBySessionState(bool, OnlineSessionState, bool)

Sets the UI buttons interactivity based on the parameters provided.

public void EnableButtonsBySessionState(bool updating, OnlineSessionState state, bool isOwner)

Parameters

updating bool

Provide "true" if the Session represented by this object is mid-update. When it's done, call this function again providing "false". This helps with trying to perform operations before a Session is finished being created or joined.

state OnlineSessionState

Status indicating the state of this Session. OnlineSessionState.NoSession indicates that there is no local Session for this object yet, suggesting that it hasn't been joined. Otherwise indicates things such as OnlineSessionState.InProgress for setting contextual buttons.

isOwner bool

Is this local user the owner of the represented Session? If false, state-affecting buttons are disabled.

EndOnClickHandler()

public void EndOnClickHandler()

JoinOnClickHandler()

public void JoinOnClickHandler()

LeaveOnClickHandler()

public void LeaveOnClickHandler()

ModOnClickHandler()

public void ModOnClickHandler()

OnlyEnableSearchResultButtons()

public void OnlyEnableSearchResultButtons()

SetUIElementsFromSession(Session, UISessionsMatchmakingMenu)

Updates all of the labels and the pressable buttons for this UI element. This version takes in only a Session. It is meant to be called when you don't need JoinOnClick to be set, perhaps because the user has already joined the Session this represents. Call SetUIElementsFromSessionAndDetails(Session, SessionDetails, UISessionsMatchmakingMenu) to set the JoinOnClick action.

public void SetUIElementsFromSession(Session session, UISessionsMatchmakingMenu ui)

Parameters

session Session

The local Session that this should represent, from the Epic Online Services C# SDK.

ui UISessionsMatchmakingMenu

The UI that contains click callback handlers.

SetUIElementsFromSessionAndDetails(Session, SessionDetails, UISessionsMatchmakingMenu)

Updates all of the labels and the pressable buttons for this UI element. This calls SetUIElementsFromSession(Session, UISessionsMatchmakingMenu), and additionally sets JoinOnClick and JoinSessionDetails.

public void SetUIElementsFromSessionAndDetails(Session session, SessionDetails details, UISessionsMatchmakingMenu ui)

Parameters

session Session

The local Session that this should represent, from the Epic Online Services C# SDK.

details SessionDetails

Additional Session information from the Epic Online Services C SDK. Used to provide additional information needed to join a Session.

ui UISessionsMatchmakingMenu

The UI that contains click callback handlers.

StartOnClickHandler()

public void StartOnClickHandler()