Detailed Description

Functions to manage the addon and get basic information about it

Function Documentation

◆ CInstanceGame()

CInstanceGame ( )

inline

Game class constructor.

Used by an add-on that only supports only Game and only in one instance.

This class is created at addon by Kodi.

Here's example about the use of this:

#include <kodi/addon-instance/Game.h>
...
 
class ATTR_DLL_LOCAL CGameExample
  : public kodi::addon::CAddonBase,
    public kodi::addon::CInstanceGame
{
public:
  CGameExample()
  {
  }
 
  virtual ~CGameExample();
  {
  }
 
  ...
};
 
ADDONCREATOR(CGameExample)

◆ ~CInstanceGame()

~CInstanceGame ( )

overridedefault

Destructor.

◆ GameClientDllPath()

std::string GameClientDllPath ( ) const

inline

Callback to Kodi Function
The path of the game client being loaded.

Returns: the used game client Dll path

Remarks: Only called from addon itself

◆ ProxyDllPaths()

bool ProxyDllPaths ( std::vector< std::string > & paths )

inline

Callback to Kodi Function
Paths to proxy DLLs used to load the game client.

Parameters

[out] paths vector list to store available dll paths

Returns: true if success and dll paths present

Remarks: Only called from addon itself

◆ ResourceDirectories()

bool ResourceDirectories ( std::vector< std::string > & dirs )

inline

Callback to Kodi Function
The "system" directories of the frontend.

These directories can be used to store system-specific ROMs such as BIOSes, configuration data, etc.

Returns: the used resource directory

Remarks: Only called from addon itself

◆ ProfileDirectory()

std::string ProfileDirectory ( ) const

inline

Callback to Kodi Function
The writable directory of the frontend.

This directory can be used to store SRAM, memory cards, high scores, etc, if the game client cannot use the regular memory interface, GetMemoryData().

Returns: the used profile directory

Remarks: Only called from addon itself

◆ SupportsVFS()

bool SupportsVFS ( ) const

inline

Callback to Kodi Function
The value of the <supports_vfs> property from addon.xml.

Returns: true if VFS is supported

Remarks: Only called from addon itself

◆ Extensions()

bool Extensions ( std::vector< std::string > & extensions )

inline

Callback to Kodi Function
The extensions in the <extensions> property from addon.xml.

Parameters

[out] extensions vector list to store available extension

Returns: true if success and extensions present

Remarks: Only called from addon itself