Table of Contents

Interface IPluginPresetConfig

Namespace
Hi3Helper.Plugin.Core.Management.PresetConfig
Assembly
Hi3Helper.Plugin.Core.dll

Defines a COM interface for accessing game preset configuration data.

[GeneratedComInterface]
[Guid("436f6c6c-6170-7365-727f-000000000011")]
[InterfaceType(ComInterfaceType.InterfaceIsIUnknown)]
[IUnknownDerived<InterfaceInformation, InterfaceImplementation>]
public interface IPluginPresetConfig : IInitializableTask, IFree

Remarks

This interface provides methods to retrieve various properties related to a game's preset configuration, such as game and zone information, supported languages, and executable details. It extends IInitializableTask to support asynchronous initialization.

Methods

Free() 

void Free()

InitAsync(in Guid, out nint) 

void InitAsync(in Guid cancelToken, out nint result)

Parameters

cancelToken Guid
result nint

comGet_GameAppDataPath(out string?)

Gets the path where the game's cache data is stored (usually, it's used as well as to store the Game's Log File for Unity games),

void comGet_GameAppDataPath(out string? result)

Parameters

result string

The path of the game's cache directory.

comGet_GameExecutableName(out string)

Gets the name of the game's executable file.

void comGet_GameExecutableName(out string result)

Parameters

result string

The executable name as a string.

comGet_GameInstaller(out IGameInstaller?)

Gets an instance to the IGameInstaller and IGameUninstaller

void comGet_GameInstaller(out IGameInstaller? result)

Parameters

result IGameInstaller

The game installer and uninstaller instance.

comGet_GameLogFileName(out string?)

Gets the file name of the game's log file.

void comGet_GameLogFileName(out string? result)

Parameters

result string

The filename or path of the log file.

comGet_GameMainLanguage(out string)

Gets the main language of the game.

void comGet_GameMainLanguage(out string result)

Parameters

result string

The main language as a string.

comGet_GameManager(out IGameManager?)

Gets an instance to the IGameManager

void comGet_GameManager(out IGameManager? result)

Parameters

result IGameManager

The game manager instance.

comGet_GameName(out string)

Gets the name of the game.

void comGet_GameName(out string result)

Parameters

result string

The game name as a string.

comGet_GameRegistryKeyName(out string)

Retrieves the registry key name for the game.

void comGet_GameRegistryKeyName(out string result)

Parameters

result string

The registry key name for the game.

comGet_GameSupportedLanguages(int, out string)

Gets the supported language at the specified index.

void comGet_GameSupportedLanguages(int index, out string result)

Parameters

index int

The index of the supported language.

result string

The 2-letter locale language code (such as: en) as a string.

comGet_GameSupportedLanguagesCount(out int)

Gets the number of supported languages for the game.

void comGet_GameSupportedLanguagesCount(out int result)

Parameters

result int

The count of supported languages as an integer.

comGet_GameVendorName(out string)

Retrieves the name of the game vendor.

void comGet_GameVendorName(out string result)

Parameters

result string

The game vendor name.

comGet_LauncherApiMedia(out ILauncherApiMedia?)

Gets an instance to the ILauncherApiMedia.

void comGet_LauncherApiMedia(out ILauncherApiMedia? result)

Parameters

result ILauncherApiMedia

The launcher Media API instance.

comGet_LauncherApiNews(out ILauncherApiNews?)

Gets an instance to the ILauncherApiNews.

void comGet_LauncherApiNews(out ILauncherApiNews? result)

Parameters

result ILauncherApiNews

The launcher News API instance.

comGet_LauncherGameDirectoryName(out string)

Gets the directory name used by the launcher for the game.

void comGet_LauncherGameDirectoryName(out string result)

Parameters

result string

The launcher game directory name as a string.

comGet_ProfileName(out string)

Gets the name of the profile.

void comGet_ProfileName(out string result)

Parameters

result string

The profile name as a string.

comGet_ReleaseChannel(out GameReleaseChannel)

Gets the release channel of the game.

void comGet_ReleaseChannel(out GameReleaseChannel result)

Parameters

result GameReleaseChannel

The GameReleaseChannel value.

comGet_ZoneDescription(out string)

Gets the description of the zone.

void comGet_ZoneDescription(out string result)

Parameters

result string

The zone description as a string.

comGet_ZoneFullName(out string)

Gets the full name of the zone.

void comGet_ZoneFullName(out string result)

Parameters

result string

The zone full name as a string.

comGet_ZoneHomePageUrl(out string)

Gets the URL of the zone's home page.

void comGet_ZoneHomePageUrl(out string result)

Parameters

result string

The zone home page URL as a string.

comGet_ZoneLogoUrl(out string)

Gets the URL of the zone's logo.

void comGet_ZoneLogoUrl(out string result)

Parameters

result string

The zone logo URL as a string.

comGet_ZoneName(out string)

Gets the short name of the zone.

void comGet_ZoneName(out string result)

Parameters

result string

The zone name as a string.

comGet_ZonePosterUrl(out string)

Gets the URL of the zone's poster.

void comGet_ZonePosterUrl(out string result)

Parameters

result string

The zone poster URL as a string.