Class UISessionsMatchmakingMenu

Namespace

PlayEveryWare.EpicOnlineServices.Samples

public class UISessionsMatchmakingMenu : SampleMenuWithFriends

Inheritance

object

SampleMenu

SampleMenuWithFriends

UISessionsMatchmakingMenu

Inherited Members

SampleMenuWithFriends.IsDirty

SampleMenuWithFriends.IsFriendsUIDirty()

SampleMenuWithFriends.SetDirtyFlag(bool)

SampleMenu.UIFirstSelected

SampleMenu.UIParent

SampleMenu.Hidden

SampleMenu.RequiresAuthentication

SampleMenu.StartsHidden

SampleMenu.Awake()

SampleMenu.Log(string, string)

Constructors

UISessionsMatchmakingMenu()

public UISessionsMatchmakingMenu()

Fields

CurrentSessionsHeader

public Text CurrentSessionsHeader

Field Value

Text

InviteFromVal

public Text InviteFromVal

Field Value

Text

InvitePresence

public Toggle InvitePresence

Field Value

Toggle

InvitesAllowedVal

public Toggle InvitesAllowedVal

Field Value

Toggle

JoinInProgressVal

public Toggle JoinInProgressVal

Field Value

Toggle

LevelVal

public Dropdown LevelVal

Field Value

Dropdown

MaxPlayersVal

public Dropdown MaxPlayersVal

Field Value

Dropdown

PermissionVal

public Dropdown PermissionVal

Field Value

Dropdown

PresenceVal

public Toggle PresenceVal

Field Value

Toggle

SanctionsVal

public Toggle SanctionsVal

Field Value

Toggle

SearchByLevelBox

public UIConsoleInputField SearchByLevelBox

Field Value

UIConsoleInputField

SessionContentParent

public GameObject SessionContentParent

Field Value

GameObject

SessionNameVal

public Text SessionNameVal

Field Value

Text

UIInvitePanel

public GameObject UIInvitePanel

Field Value

GameObject

UISessionEntryPrefab

public GameObject UISessionEntryPrefab

Field Value

GameObject

Properties

OwnInvitationState

Cached state that indicates if the local user can send invitations for a Session. Processed in OnFriendStateChanged(), and utilized in GetFriendInteractionState(FriendData).

protected UISessionsMatchmakingMenu.OwnSessionInvitationAbilityState OwnInvitationState { get; set; }

Property Value

UISessionsMatchmakingMenu.OwnSessionInvitationAbilityState

Methods

AcceptInviteButtonOnClick()

public void AcceptInviteButtonOnClick()

CreateNewSessionOnClick()

public void CreateNewSessionOnClick()

DeclineInviteButtonOnClick()

public void DeclineInviteButtonOnClick()

EndButtonOnClick(string)

public void EndButtonOnClick(string sessionName)

Parameters

sessionName string

GetFriendInteractButtonText()

public override string GetFriendInteractButtonText()

Returns

string

GetFriendInteractionState(FriendData)

public override SampleMenuWithFriends.FriendInteractionState GetFriendInteractionState(FriendData friendData)

Parameters

friendData FriendData

Returns

SampleMenuWithFriends.FriendInteractionState

Hide()

Hides the SampleMenu. If overriding, make sure to call this base implementation first.

public override void Hide()

JoinButtonOnClick(SessionDetails)

public void JoinButtonOnClick(SessionDetails sessionHandle)

Parameters

sessionHandle SessionDetails

LeaveButtonOnClick(string)

public void LeaveButtonOnClick(string sessionName)

Parameters

sessionName string

ModifyButtonOnClick(string)

public void ModifyButtonOnClick(string sessionName)

Parameters

sessionName string

OnDestroy()

When overriding, call this base implementation first.

protected override void OnDestroy()

OnEnable()

When overriding, call this base implementation first.

protected override void OnEnable()

OnFriendInteractButtonClicked(FriendData)

public override void OnFriendInteractButtonClicked(FriendData friendData)

Parameters

friendData FriendData

OnFriendStateChanged()

This function is called before refreshing the UIFriendsMenu. This is an opportunity to refresh any caches or do processing work that should be done once, instead of processed for each call of GetFriendInteractionState(FriendData).

public override void OnFriendStateChanged()

OnSessionRefresh(Session, SessionDetails)

After a Session is successfully refreshed, this is run to update the UI with the new information about the local Session.

public void OnSessionRefresh(Session session, SessionDetails details)

Parameters

session Session

Information about the Session from the EOS C# SDK.

details SessionDetails

Additional information about the Session from the EOS C SDK.

RefreshSearch()

public void RefreshSearch()

SearchByLevelEndEdit(string)

public void SearchByLevelEndEdit(string searchPattern)

Parameters

searchPattern string

Show()

Shows the SampleMenu. If overriding, make sure to call this base implementation first.

public override void Show()

StartButtonOnClick(string)

public void StartButtonOnClick(string sessionName)

Parameters

sessionName string

TryGetExistingUISessionEntryById(string, out UISessionEntry)

public bool TryGetExistingUISessionEntryById(string sessionId, out UISessionEntry entry)

Parameters

sessionId string

entry UISessionEntry

Returns

bool

Update()

When overriding, call this base implementation first.

protected override void Update()