Class SampleMenu

Namespace

PlayEveryWare.EpicOnlineServices.Samples

Contains implementation common to all sample menus.

public abstract class SampleMenu : MonoBehaviour

Inheritance

object

SampleMenu

Derived

SampleMenuWithFriends

UIAchievementsMenu

UIFriendsMenu

UILeaderboardMenu

UIMetricsMenu

UIPlayerDataStorageMenu

UIStoreMenu

UITitleStorageMenu

Constructors

SampleMenu(bool, bool)

Constructor for SampleMenu.

protected SampleMenu(bool startsHidden = true, bool requiresAuthentication = true)

Parameters

startsHidden bool

Indicates whether the SampleMenu should be visible or hidden when it launches. Most of them should be hidden.

requiresAuthentication bool

Indicates whether the SampleMenu requires a user be authenticated in order for it to be used. Most of them require authentication.

Fields

UIFirstSelected

Editable within the Unity Editor, it should be set to the control which should have focus when the SampleMenu first becomes visible.

public GameObject UIFirstSelected

Field Value

GameObject

UIParent

Editable within the Unity Editor, it should be set to the parent of the SampleMenu in the Scene hierarchy.

public GameObject UIParent

Field Value

GameObject

Properties

Hidden

Indicates whether the SampleMenu is hidden or not.

public bool Hidden { get; }

Property Value

bool

RequiresAuthentication

Indicates whether the SampleMenu requires a user be authenticated in order to interact with the scene.

public bool RequiresAuthentication { get; }

Property Value

bool

StartsHidden

Indicates whether the SampleMenu starts out hidden or visible. NOTE: This Property might be something that can be removed, it exists primarily to maintain functionality of current scenes.

public bool StartsHidden { get; }

Property Value

bool

Methods

Awake()

When overriding, call this base implementation first.

protected virtual void Awake()

Hide()

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

public virtual void Hide()

Log(string, string)

[Conditional("SAMPLE_MENU_DEBUG")]
protected void Log(string message, string memberName = "")

Parameters

message string

memberName string

OnDestroy()

When overriding, call this base implementation first.

protected virtual void OnDestroy()

OnEnable()

When overriding, call this base implementation first.

protected virtual void OnEnable()

Show()

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

public virtual void Show()

Update()

When overriding, call this base implementation first.

protected virtual void Update()