Table of Contents

Class PluginPresetConfigBase

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

This class is used to provide the abstract class of the plugin preset config.
PLEASE Do NOT use this class or return this class directly. Instead, use this class as a base class and override the properties to provide the preset config.

[GeneratedComClass]
[ComExposedClass<ComClassInformation>]
public abstract class PluginPresetConfigBase : InitializableTask, IPluginPresetConfig, IInitializableTask, IFree
Inheritance
PluginPresetConfigBase
Implements
Inherited Members

Properties

GameAppDataPath

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),

public abstract string GameAppDataPath { get; }

Property Value

string

GameExecutableName

Gets the name of the game's executable file.

public abstract string GameExecutableName { get; }

Property Value

string

GameInstaller

Gets an instance to the IGameInstaller and IGameUninstaller

public abstract IGameInstaller? GameInstaller { get; set; }

Property Value

IGameInstaller

GameLogFileName

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

public abstract string GameLogFileName { get; }

Property Value

string

GameMainLanguage

Gets the main language of the game.

public abstract string GameMainLanguage { get; }

Property Value

string

GameManager

Gets an instance to the IGameManager

public abstract IGameManager? GameManager { get; set; }

Property Value

IGameManager

GameName

Gets the name of the game.

public abstract string? GameName { get; }

Property Value

string

GameRegistryKeyName

Retrieves the registry key name for the game.

public abstract string GameRegistryKeyName { get; }

Property Value

string

GameVendorName

Retrieves the name of the game vendor.

public abstract string GameVendorName { get; }

Property Value

string

LauncherApiMedia

Gets an instance to the ILauncherApiMedia.

public abstract ILauncherApiMedia? LauncherApiMedia { get; set; }

Property Value

ILauncherApiMedia

LauncherApiNews

Gets an instance to the ILauncherApiNews.

public abstract ILauncherApiNews? LauncherApiNews { get; set; }

Property Value

ILauncherApiNews

LauncherGameDirectoryName

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

public abstract string LauncherGameDirectoryName { get; }

Property Value

string

ProfileName

Gets the name of the profile.

public abstract string ProfileName { get; }

Property Value

string

ReleaseChannel

Gets the release channel of the game.

public abstract GameReleaseChannel ReleaseChannel { get; }

Property Value

GameReleaseChannel

SupportedLanguages

Gets the supported language at the specified index.

public abstract List<string> SupportedLanguages { get; }

Property Value

List<string>

ZoneDescription

Gets the description of the zone.

public abstract string ZoneDescription { get; }

Property Value

string

ZoneFullName

Gets the full name of the zone.

public abstract string ZoneFullName { get; }

Property Value

string

ZoneHomePageUrl

Gets the URL of the zone's home page.

public abstract string ZoneHomePageUrl { get; }

Property Value

string

ZoneLogoUrl

Gets the URL of the zone's logo.

public abstract string ZoneLogoUrl { get; }

Property Value

string

ZoneName

Gets the short name of the zone.

public abstract string ZoneName { get; }

Property Value

string

ZonePosterUrl

Gets the URL of the zone's poster.

public abstract string ZonePosterUrl { get; }

Property Value

string

Methods

Dispose() 

public virtual void Dispose()

Free()

Free the resources associated by an instance.

public override void Free()

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),

public 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.

public 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

public 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.

public 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.

public 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

public void comGet_GameManager(out IGameManager? result)

Parameters

result IGameManager

The game manager instance.

comGet_GameName(out string)

Gets the name of the game.

public 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.

public 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.

public 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.

public 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.

public void comGet_GameVendorName(out string result)

Parameters

result string

The game vendor name.

comGet_LauncherApiMedia(out ILauncherApiMedia?)

Gets an instance to the ILauncherApiMedia.

public void comGet_LauncherApiMedia(out ILauncherApiMedia? result)

Parameters

result ILauncherApiMedia

The launcher Media API instance.

comGet_LauncherApiNews(out ILauncherApiNews?)

Gets an instance to the ILauncherApiNews.

public 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.

public 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.

public 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.

public void comGet_ReleaseChannel(out GameReleaseChannel result)

Parameters

result GameReleaseChannel

The GameReleaseChannel value.

comGet_ZoneDescription(out string)

Gets the description of the zone.

public 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.

public 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.

public 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.

public 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.

public 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.

public void comGet_ZonePosterUrl(out string result)

Parameters

result string

The zone poster URL as a string.