InfoTagGame

Detailed Description

Kodi's game info tag class.

Class: InfoTagGame()

Access and / or modify the game metadata of a ListItem.

---

v20 Python API changes:

New class added.

Example:

...
tag = item.getGameInfoTag()
 
title = tag.getTitle()
tag.setDeveloper('John Doe')
...

Function Documentation

InfoTagGame()

InfoTagGame

(

...

)

Function: xbmc.InfoTagGame([offscreen])

---

Create a game info tag.

Parameters

offscreen

[opt] bool (default False) - if GUI based locks should be avoided. Most of the times listitems are created offscreen and added later to a container for display (e.g. plugins) or they are not even displayed (e.g. python scrapers). In such cases, there is no need to lock the GUI when creating the items (increasing your addon performance). Note however, that if you are creating listitems and managing the container itself (e.g using WindowXML or WindowXMLDialog classes) subsquent modifications to the item will require locking. Thus, in such cases, use the default value (False).

---

v20 Python API changes:

New function added.

Example:

...
gameinfo = xbmc.InfoTagGame(offscreen=False)
...

getTitle()

getTitle

(

)

Function: getTitle()

---

Gets the title of the game.

Returns

[string] title

---

v20 Python API changes:

New function added.

getPlatform()

getPlatform

(

)

Function: getPlatform()

---

Gets the platform on which the game is run.

Returns

[string] platform

---

v20 Python API changes:

New function added.

getGenres()

getGenres

(

)

Function: getGenres()

---

Gets the genres of the game.

Returns

[list] genres

---

v20 Python API changes:

New function added.

getPublisher()

getPublisher

(

)

Function: getPublisher()

---

Gets the publisher of the game.

Returns

[string] publisher

---

v20 Python API changes:

New function added.

getDeveloper()

getDeveloper

(

)

Function: getDeveloper()

---

Gets the developer of the game.

Returns

[string] developer

---

v20 Python API changes:

New function added.

getOverview()

getOverview

(

)

Function: getOverview()

---

Gets the overview of the game.

Returns

[string] overview

---

v20 Python API changes:

New function added.

getYear()

getYear

(

)

Function: getYear()

---

Gets the year in which the game was published.

Returns

[integer] year

---

v20 Python API changes:

New function added.

getGameClient()

getGameClient

(

)

Function: getGameClient()

---

Gets the add-on ID of the game client executing the game.

Returns

[string] game client

---

v20 Python API changes:

New function added.

setTitle()

setTitle

(

...

)

Function: setTitle(title)

---

Sets the title of the game.

Parameters

title

string - title.

---

v20 Python API changes:

New function added.

setPlatform()

setPlatform

(

...

)

Function: setPlatform(platform)

---

Sets the platform on which the game is run.

Parameters

platform

string - platform.

---

v20 Python API changes:

New function added.

setGenres()

setGenres

(

...

)

Function: setGenres(genres)

---

Sets the genres of the game.

Parameters

genres

list - genres.

---

v20 Python API changes:

New function added.

setPublisher()

setPublisher

(

...

)

Function: setPublisher(publisher)

---

Sets the publisher of the game.

Parameters

publisher

string - publisher.

---

v20 Python API changes:

New function added.

setDeveloper()

setDeveloper

(

...

)

Function: setDeveloper(developer)

---

Sets the developer of the game.

Parameters

developer

string - title.

---

v20 Python API changes:

New function added.

setOverview()

setOverview

(

...

)

Function: setOverview(overview)

---

Sets the overview of the game.

Parameters

overview

string - overview.

---

v20 Python API changes:

New function added.

setYear()

setYear

(

...

)

Function: setYear(year)

---

Sets the year in which the game was published.

Parameters

year	integer - year.

---

v20 Python API changes:

New function added.

setGameClient()

setGameClient

(

...

)

Function: setGameClient(gameClient)

---

Sets the add-on ID of the game client executing the game.

Parameters

gameClient

string - game client.

---

v20 Python API changes:

New function added.