host.anzo.eossdk.eos.sdk

Class EOS_UI_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_UI_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_UI_Interface
extends com.sun.jna.PointerType

The UI Interface is used to access the Social Overlay UI. Each UI component will have a function for opening it. All UI Interface calls take a handle of type EOS_HUI as the first parameter. This handle can be retrieved from an EOS_HPlatform handle by using the EOS_Platform_GetUIInterface function.

Since:

9/7/2023

See Also:

EOS_Platform_Interface.getUIInterface()

Constructor Summary

Constructors

Constructor and Description
EOS_UI_Interface()
EOS_UI_Interface(com.sun.jna.Pointer address)

Method Summary

Modifier and Type	Method and Description
EOS_EResult	acknowledgeEventId(EOS_UI_AcknowledgeEventIdOptions options) Lets the SDK know that the given UI event ID has been acknowledged and should be released.
EOS_NotificationId	addNotifyDisplaySettingsUpdated(EOS_UI_AddNotifyDisplaySettingsUpdatedOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnDisplaySettingsUpdatedCallback completionDelegate) Register to receive notifications when the overlay display settings are updated.
EOS_NotificationId	addNotifyMemoryMonitor(EOS_UI_AddNotifyMemoryMonitorOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnMemoryMonitorCallback completionDelegate) Register to receive notifications from the memory monitor.
boolean	getFriendsExclusiveInput(EOS_UI_GetFriendsExclusiveInputOptions options) Gets the friends overlay exclusive input state.
boolean	getFriendsVisible(EOS_UI_GetFriendsVisibleOptions options) Gets the friends overlay visibility.
EOS_UI_ENotificationLocation	getNotificationLocationPreference() Returns the current notification location display preference.
EOS_UI_EInputStateButtonFlags	getToggleFriendsButton(EOS_UI_GetToggleFriendsButtonOptions options) Returns the current Toggle Friends Button.
EOS_UI_EKeyCombination	getToggleFriendsKey(EOS_UI_GetToggleFriendsKeyOptions options) Returns the current Toggle Friends Key.
void	hideFriends(EOS_UI_HideFriendsOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnHideFriendsCallback completionDelegate) Hides the active Social Overlay.
boolean	isSocialOverlayPaused(EOS_UI_IsSocialOverlayPausedOptions options) Gets the IsPaused state of the overlay as set by any previous calls to EOS_UI_PauseSocialOverlay().
boolean	isValidButtonCombination(EOS_UI_EInputStateButtonFlags buttonCombination) Determine if a button combination is valid.
boolean	isValidKeyCombination(EOS_UI_EKeyCombination keyCombination) Determine if a key combination is valid.
EOS_EResult	pauseSocialOverlay(EOS_UI_PauseSocialOverlayOptions options) Sets the IsPaused state of the overlay.
EOS_EResult	prePresent(EOS_UI_PrePresentOptions options) Gives the Overlay the chance to issue its own drawing commands on console platforms.
void	removeNotifyDisplaySettingsUpdated(EOS_NotificationId id) Unregister from receiving notifications when the overlay display settings are updated.
void	removeNotifyMemoryMonitor(EOS_NotificationId id) Unregister from receiving notifications when the memory monitor posts a notification.
EOS_EResult	reportInputState(EOS_UI_ReportInputStateOptions options) Pushes platform agnostic input state to the SDK.
EOS_EResult	setDisplayPreference(EOS_UI_SetDisplayPreferenceOptions options) Define any preferences for any display settings.
EOS_EResult	setToggleFriendsButton(EOS_UI_SetToggleFriendsButtonOptions options) Updates the current Toggle Friends Button.
EOS_EResult	setToggleFriendsKey(EOS_UI_SetToggleFriendsKeyOptions options) Updates the current Toggle Friends Key.
void	showBlockPlayer(EOS_UI_ShowBlockPlayerOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnShowBlockPlayerCallback completionDelegate) Requests that the Social Overlay open and display the "Block User" flow for the specified user.
void	showFriends(EOS_UI_ShowFriendsOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnShowFriendsCallback completionDelegate) Opens the Social Overlay with a request to show the friends list.
void	showNativeProfile(EOS_UI_ShowNativeProfileOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnShowNativeProfileCallback completionDelegate) Requests that the native ID for a target player be identified and the native profile be displayed for that player.
void	showReportPlayer(EOS_UI_ShowReportPlayerOptions options, com.sun.jna.Pointer clientData, EOS_UI_OnShowReportPlayerCallback completionDelegate) Requests that the Social Overlay open and display the "Report User" flow for the specified user.

Methods inherited from class com.sun.jna.PointerType

equals, fromNative, getPointer, hashCode, nativeType, setPointer, toNative, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

EOS_UI_Interface

public EOS_UI_Interface(com.sun.jna.Pointer address)

EOS_UI_Interface

public EOS_UI_Interface()

Method Detail

showFriends

public void showFriends(EOS_UI_ShowFriendsOptions options,
                        com.sun.jna.Pointer clientData,
                        EOS_UI_OnShowFriendsCallback completionDelegate)

Opens the Social Overlay with a request to show the friends list.

Parameters:

options - Structure containing the Epic Account ID of the friends list to show.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

completionDelegate - A callback that is fired when the request to show the friends list has been sent to the Social Overlay, or on an error.

hideFriends

public void hideFriends(EOS_UI_HideFriendsOptions options,
                        com.sun.jna.Pointer clientData,
                        EOS_UI_OnHideFriendsCallback completionDelegate)

Hides the active Social Overlay.

Parameters:

options - Structure containing the Epic Account ID of the browser to close.

clientData - Arbitrary data that is passed back to you in the completionDelegate.

completionDelegate - A callback that is fired when the request to hide the friends list has been processed, or on an error.

getFriendsVisible

public boolean getFriendsVisible(EOS_UI_GetFriendsVisibleOptions options)

Gets the friends overlay visibility.

Parameters:

options - Structure containing the Epic Account ID of the friends Social Overlay owner.

Returns:

true If the overlay is visible.

getFriendsExclusiveInput

public boolean getFriendsExclusiveInput(EOS_UI_GetFriendsExclusiveInputOptions options)

Gets the friends overlay exclusive input state.

Parameters:

options - Structure containing the Epic Account ID of the friends Social Overlay owner.

Returns:

true If the overlay has exclusive input.

addNotifyDisplaySettingsUpdated

public EOS_NotificationId addNotifyDisplaySettingsUpdated(EOS_UI_AddNotifyDisplaySettingsUpdatedOptions options,
                                                          com.sun.jna.Pointer clientData,
                                                          EOS_UI_OnDisplaySettingsUpdatedCallback completionDelegate)

Register to receive notifications when the overlay display settings are updated. Newly registered handlers will always be called the next tick with the current state.
Must call removeNotifyDisplaySettingsUpdated(EOS_NotificationId) to remove the notification.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the notificationFn.

completionDelegate - A callback that is fired when the overlay display settings are updated.

Returns:

handle representing the registered callback

removeNotifyDisplaySettingsUpdated

public void removeNotifyDisplaySettingsUpdated(EOS_NotificationId id)

Unregister from receiving notifications when the overlay display settings are updated.

Parameters:

id - Handle representing the registered callback

setToggleFriendsKey

public EOS_EResult setToggleFriendsKey(EOS_UI_SetToggleFriendsKeyOptions options)

Updates the current Toggle Friends Key. This key can be used by the user to toggle the friends overlay when available. The default value represents `Shift + F3` as `((int32_t)EOS_UIK_Shift | (int32_t)EOS_UIK_F3)`. The provided key should satisfy EOS_UI_IsValidKeyCombination. The value EOS_UIK_None is specially handled by resetting the key binding to the system default.

Parameters:

options - Structure containing the key combination to use.

Returns:

EOS_EResult.EOS_Success If the overlay has been notified about the request.
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect.
EOS_EResult.EOS_InvalidParameters If any of the options are incorrect.
EOS_EResult.EOS_NotConfigured If the overlay is not properly configured.
EOS_EResult.EOS_NoChange If the key combination did not change.

See Also:

isValidKeyCombination(EOS_UI_EKeyCombination)

getToggleFriendsKey

public EOS_UI_EKeyCombination getToggleFriendsKey(EOS_UI_GetToggleFriendsKeyOptions options)

Returns the current Toggle Friends Key. This key can be used by the user to toggle the friends overlay when available. The default value represents `Shift + F3` as `((int32_t)EOS_UIK_Shift | (int32_t)EOS_UIK_F3)`.

Parameters:

options - Structure containing any options that are needed to retrieve the key.

Returns:

A valid key combination which represent a single key with zero or more modifier keys. EOS_UIK_None will be returned if any error occurs.

See Also:

EOS_UI_EKeyCombination

isValidKeyCombination

public boolean isValidKeyCombination(EOS_UI_EKeyCombination keyCombination)

Determine if a key combination is valid. A key combinations must have a single key and at least one modifier. The single key must be one of the following: F1 through F12, Space, Backspace, Escape, or Tab. The modifier key must be one or more of the following: Shift, Control, or Alt.

Parameters:

keyCombination - The key to test.

Returns:

true if the provided key combination is valid.

setToggleFriendsButton

public EOS_EResult setToggleFriendsButton(EOS_UI_SetToggleFriendsButtonOptions options)

Updates the current Toggle Friends Button. This button can be used by the user to toggle the friends overlay when available.

The default value is EOS_UISBF_None. The provided button must satisfy EOS_UI_IsValidButtonCombination.

On PC the EOS Overlay automatically listens to gamepad input and routes it to the overlay when appropriate. If this button is configured, the user may open the overlay using either this button or the toggle friends key. On console platforms, the game must be calling EOS_UI_ReportInputState to route gamepad input to the EOS Overlay.

Note: If you do not have a button mapped, it'll suppress the part of the toast notification that prompts the user to press it.

Parameters:

options - Structure containing the button combination to use.

Returns:

EOS_EResult.EOS_Success If the overlay has been notified about the request.
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect.
EOS_EResult.EOS_InvalidParameters If any of the options are incorrect.
EOS_EResult.EOS_NotConfigured If the overlay is not properly configured.
EOS_EResult.EOS_NoChange If the button combination did not change.

See Also:

isValidKeyCombination(EOS_UI_EKeyCombination), reportInputState(EOS_UI_ReportInputStateOptions)

getToggleFriendsButton

public EOS_UI_EInputStateButtonFlags getToggleFriendsButton(EOS_UI_GetToggleFriendsButtonOptions options)

Returns the current Toggle Friends Button. This button can be used by the user to toggle the friends overlay when available. The default value is EOS_UISBF_None.

Parameters:

options - Structure containing any options that are needed to retrieve the button.

Returns:

A valid button combination which represents any number of buttons. EOS_UI_EInputStateButtonFlags.EOS_UISBF_None will be returned if any error occurs.

isValidButtonCombination

public boolean isValidButtonCombination(EOS_UI_EInputStateButtonFlags buttonCombination)

Determine if a button combination is valid.

Parameters:

buttonCombination - The button to test.

Returns:

true if the provided button combination is valid.

See Also:

EOS_UI_EInputStateButtonFlags

setDisplayPreference

public EOS_EResult setDisplayPreference(EOS_UI_SetDisplayPreferenceOptions options)

Define any preferences for any display settings.

Parameters:

options - Structure containing any options that are needed to set

Returns:

EOS_EResult.EOS_Success If the overlay has been notified about the request.
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect.
EOS_EResult.EOS_InvalidParameters If any of the options are incorrect.
EOS_EResult.EOS_NotConfigured If the overlay is not properly configured.
EOS_EResult.EOS_NoChange If the preferences did not change.

getNotificationLocationPreference

public EOS_UI_ENotificationLocation getNotificationLocationPreference()

Returns the current notification location display preference.

Returns:

The current notification location display preference.

acknowledgeEventId

public EOS_EResult acknowledgeEventId(EOS_UI_AcknowledgeEventIdOptions options)

Lets the SDK know that the given UI event ID has been acknowledged and should be released.

Parameters:

options - Structure containing the UI event ID to acknowledge.

Returns:

EOS_EResult.EOS_Success is returned if the UI event ID has been acknowledged.
EOS_EResult.EOS_NotFound is returned if the UI event ID does not exist.

See Also:

EOS_Presence_JoinGameAcceptedCallbackInfo

reportInputState

public EOS_EResult reportInputState(EOS_UI_ReportInputStateOptions options)

Pushes platform agnostic input state to the SDK. The state is passed to the EOS Overlay on console platforms. This function has an empty implementation (i.e. returns EOS_NotImplemented) on all non-consoles platforms.

Parameters:

options - Structure containing the input state

Returns:

EOS_EResult.EOS_Success If the Social Overlay has been notified about the request.
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect.
EOS_EResult.EOS_NotConfigured If the Social Overlay is not properly configured.
EOS_EResult.EOS_NotImplementedx If the application is suspended.
EOS_EResult.EOS_NotImplemented If this function is not implemented on the current platform.

prePresent

public EOS_EResult prePresent(EOS_UI_PrePresentOptions options)

Gives the Overlay the chance to issue its own drawing commands on console platforms. Issued by the hosting application after it has finished the backbuffer and is ready to trigger presenting it. As this process can be involved and rather varied depending on platform we do not plan to make the call replace the standard "present" call, but rather expect it to be issued "just before" that call. This function has an empty implementation (i.e. returns EOS_NotImplemented) on all non-consoles platforms.

Parameters:

options - will vary from platform to platform. Main difference will be due to a platforms ability to provide multiple rendering queues.

Returns:

An EOS_EResult is returned to indicate success or an error.

showBlockPlayer

public void showBlockPlayer(EOS_UI_ShowBlockPlayerOptions options,
                            com.sun.jna.Pointer clientData,
                            EOS_UI_OnShowBlockPlayerCallback completionDelegate)

Requests that the Social Overlay open and display the "Block User" flow for the specified user.

Parameters:

options - Structure containing information about the user to be blocked.

clientData - Arbitrary data that is passed back to you in the notificationFn.

completionDelegate - A callback that is fired when the user exits the Block UI.

showReportPlayer

public void showReportPlayer(EOS_UI_ShowReportPlayerOptions options,
                             com.sun.jna.Pointer clientData,
                             EOS_UI_OnShowReportPlayerCallback completionDelegate)

Requests that the Social Overlay open and display the "Report User" flow for the specified user.

Parameters:

options - Structure containing information about the user to be reported.

clientData - Arbitrary data that is passed back to you in the notificationFn.

completionDelegate - A callback that is fired when the user exits the Report UI.

pauseSocialOverlay

public EOS_EResult pauseSocialOverlay(EOS_UI_PauseSocialOverlayOptions options)

Sets the IsPaused state of the overlay. While true then all notifications will be delayed until after the IsPaused is false again. While true then the key and button events will not toggle the overlay. If the Overlay was visible before being paused then it will be hidden. If it is known that the Overlay should now be visible after being paused then it will be shown.

Parameters:

options - Structure containing the desired IsPaused state.

Returns:

EOS_EResult.EOS_Success If the overlay has been notified about the request.
EOS_EResult.EOS_IncompatibleVersion if the API version passed in is incorrect.
EOS_EResult.EOS_InvalidParameters If any of the options are incorrect.
EOS_EResult.EOS_NotConfigured If the overlay is not properly configured.

isSocialOverlayPaused

public boolean isSocialOverlayPaused(EOS_UI_IsSocialOverlayPausedOptions options)

Gets the IsPaused state of the overlay as set by any previous calls to EOS_UI_PauseSocialOverlay().

Parameters:

options - Structure containing any options that are needed to retrieve the IsPaused state.

Returns:

true If the overlay is paused.

See Also:

pauseSocialOverlay(EOS_UI_PauseSocialOverlayOptions)

addNotifyMemoryMonitor

public EOS_NotificationId addNotifyMemoryMonitor(EOS_UI_AddNotifyMemoryMonitorOptions options,
                                                 com.sun.jna.Pointer clientData,
                                                 EOS_UI_OnMemoryMonitorCallback completionDelegate)

Register to receive notifications from the memory monitor. Newly registered handlers will always be called the next tick with the current state.
If the returned NotificationId is valid, you must call #removeNotifyMemoryMonitor(EOS_NotificationId)} when you no longer wish to have your NotificationHandler called.

Parameters:

options - Structure containing information about the request.

clientData - Arbitrary data that is passed back to you in the notificationFn.

completionDelegate - A callback that is fired when the overlay display settings are updated.

Returns:

handle representing the registered callback

removeNotifyMemoryMonitor

public void removeNotifyMemoryMonitor(EOS_NotificationId id)

Unregister from receiving notifications when the memory monitor posts a notification.

Parameters:

id - Handle representing the registered callback

showNativeProfile

public void showNativeProfile(EOS_UI_ShowNativeProfileOptions options,
                              com.sun.jna.Pointer clientData,
                              EOS_UI_OnShowNativeProfileCallback completionDelegate)

Requests that the native ID for a target player be identified and the native profile be displayed for that player.

Parameters:

options - Structure containing information about the user whose profile is to be shown.

clientData - Arbitrary data that is passed back to you in the notificationFn.

completionDelegate - A callback that is fired when the profile has been shown.