host.anzo.eossdk.eos.sdk

Class EOS_Mods_Interface

java.lang.Object

com.sun.jna.PointerType

host.anzo.eossdk.eos.sdk.EOS_Mods_Interface

All Implemented Interfaces:

com.sun.jna.NativeMapped

public class EOS_Mods_Interface
extends com.sun.jna.PointerType

The Mods Interface is used to manage a user's mods. Allowing a user to install/uninstall/enumerate mods. All Mods Interface calls take a handle of type EOS_HMods as the first parameter. This handle can be retrieved from a EOS_HPlatform handle by using the EOS_Platform_GetModsInterface function.

NOTE: At this time, this feature is only available for desktop platforms and for products that are part of the Epic Games store.

Since:

8/15/2023

See Also:

EOS_Platform_Interface.getModsInterface()

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
EOS_Mods_ModInfo	copyModInfo(EOS_Mods_CopyModInfoOptions options) Get cached enumerated mods object.
void	enumerateMods(EOS_Mods_EnumerateModsOptions options, com.sun.jna.Pointer clientData, EOS_Mods_OnEnumerateModsCallback completionDelegate) Starts an asynchronous task that makes a request to enumerate mods for the specified game.
void	installMod(EOS_Mods_InstallModOptions options, com.sun.jna.Pointer clientData, EOS_Mods_OnInstallModCallback completionDelegate) Starts an asynchronous task that makes a request to install the specified mod.
void	uninstallMod(EOS_Mods_UninstallModOptions options, com.sun.jna.Pointer clientData, EOS_Mods_OnUninstallModCallback completionDelegate) Starts an asynchronous task that makes a request to uninstall the specified mod.
void	updateMod(EOS_Mods_UpdateModOptions options, com.sun.jna.Pointer clientData, EOS_Mods_OnUpdateModCallback completionDelegate) Starts an asynchronous task that makes a request to update the specified mod to the latest version.

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_Mods_Interface

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

EOS_Mods_Interface

public EOS_Mods_Interface()

Method Detail

installMod

public void installMod(EOS_Mods_InstallModOptions options,
                       com.sun.jna.Pointer clientData,
                       EOS_Mods_OnInstallModCallback completionDelegate)

Starts an asynchronous task that makes a request to install the specified mod.

Parameters:

options - structure containing the game and mod identifiers

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

uninstallMod

public void uninstallMod(EOS_Mods_UninstallModOptions options,
                         com.sun.jna.Pointer clientData,
                         EOS_Mods_OnUninstallModCallback completionDelegate)

Starts an asynchronous task that makes a request to uninstall the specified mod.

Parameters:

options - structure containing the game and mod identifiers

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

enumerateMods

public void enumerateMods(EOS_Mods_EnumerateModsOptions options,
                          com.sun.jna.Pointer clientData,
                          EOS_Mods_OnEnumerateModsCallback completionDelegate)

Starts an asynchronous task that makes a request to enumerate mods for the specified game. Types of the mods to enumerate can be specified through EOS_Mods_EnumerateModsOptions

Parameters:

options - structure containing the game identifiers

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error

copyModInfo

public EOS_Mods_ModInfo copyModInfo(EOS_Mods_CopyModInfoOptions options)
                             throws EOSException

Get cached enumerated mods object. If successful, this data must be released by calling EOS_Mods_ModInfo_Release Types of the cached enumerated mods can be specified through EOS_Mods_CopyModInfoOptions
This request may fail with an EOS_NotFound code if an enumeration of a certain type was not performed before this call.

Parameters:

options - structure containing the game identifier for which requesting enumerated mods

Returns:

Enumerated mods Info. If the returned result is success, this will be set to data that must be later released, otherwise this will be set to NULL

Throws:

EOSException - if the request was invalid or we do not have cached data.

See Also:

EOS_Mods_ModInfo.release()

updateMod

public void updateMod(EOS_Mods_UpdateModOptions options,
                      com.sun.jna.Pointer clientData,
                      EOS_Mods_OnUpdateModCallback completionDelegate)

Starts an asynchronous task that makes a request to update the specified mod to the latest version.

Parameters:

options - structure containing the game and mod identifiers

clientData - arbitrary data that is passed back to you in the CompletionDelegate

completionDelegate - a callback that is fired when the async operation completes, either successfully or in error. If the mod is up to date then the operation will complete with success.