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')
...
◆ 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) subsequent 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()
Function: getTitle()
Gets the title of the game.
- Returns
- [string] title
- v20 Python API changes
- New function added.
◆ getPlatform()
Function: getPlatform()
Gets the platform on which the game is run.
- Returns
- [string] platform
- v20 Python API changes
- New function added.
◆ getGenres()
Function: getGenres()
Gets the genres of the game.
- Returns
- [list] genres
- v20 Python API changes
- New function added.
◆ getPublisher()
Function: getPublisher()
Gets the publisher of the game.
- Returns
- [string] publisher
- v20 Python API changes
- New function added.
◆ getDeveloper()
Function: getDeveloper()
Gets the developer of the game.
- Returns
- [string] developer
- v20 Python API changes
- New function added.
◆ getOverview()
Function: getOverview()
Gets the overview of the game.
- Returns
- [string] overview
- v20 Python API changes
- New function added.
◆ getYear()
Function: getYear()
Gets the year in which the game was published.
- Returns
- [integer] year
- v20 Python API changes
- New function added.
◆ 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.
◆ getOriginalTitle()
Function: getOriginalTitle()
Gets the original title of the game, such as the one it was first released under.
- Returns
- [string] original title
- v23 Python API changes
- New function added.
◆ getRating()
Function: getRating()
Gets the rating of the game, out of 10.
- Returns
- [float] rating
- v23 Python API changes
- New function added.
◆ getPlayers()
Function: getPlayers()
Gets the most players who can play the game at once.
- Returns
- [integer] players, or 0 if unknown
- v23 Python API changes
- New function added.
◆ getAgeRating()
Function: getAgeRating()
Gets the age rating of the game: the rating board followed by its rating, e.g. "PEGI 12" (Europe, ages 12 and up), "BBFC 15" (UK, ages 15 and up), "ESRB T" (North America, Teen, ages 13 and up) or "CERO B" (Japan, ages 12 and up). Each region's board has its own scale, and Kodi doesn't convert between them.
- Returns
- [string] age rating
- v23 Python API changes
- New function added.
◆ getTrailer()
Function: getTrailer()
Gets the path or URL of the game's trailer.
- Returns
- [string] trailer
- v23 Python API changes
- New function added.
◆ getTags()
◆ setTitle()
◆ 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()
◆ setPublisher()
Function: setPublisher(publisher)
Sets the publisher of the game.
- Parameters
-
| publisher | string - publisher. |
- v20 Python API changes
- New function added.
◆ setDeveloper()
Function: setDeveloper(developer)
Sets the developer of the game.
- Parameters
-
- v20 Python API changes
- New function added.
◆ setOverview()
Function: setOverview(overview)
Sets the overview of the game.
- Parameters
-
| overview | string - overview. |
- v20 Python API changes
- New function added.
◆ setYear()
Function: setYear(year)
Sets the year in which the game was published.
- Parameters
-
- v20 Python API changes
- New function added.
◆ 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.
◆ setOriginalTitle()
Function: setOriginalTitle(originalTitle)
Sets the original title of the game, such as the one it was first released under.
- Parameters
-
| originalTitle | string - original title. |
- v23 Python API changes
- New function added.
◆ setRating()
Function: setRating(rating)
Sets the rating of the game, out of 10.
- Parameters
-
| rating | float - rating, from 0.0 to 10.0. Anything outside that is ignored. |
- v23 Python API changes
- New function added.
◆ setPlayers()
Function: setPlayers(players)
Sets the most players who can play the game at once.
- Parameters
-
| players | integer - number of players, or 0 if unknown. |
- v23 Python API changes
- New function added.
◆ setAgeRating()
Function: setAgeRating(ageRating)
Sets the age rating of the game: the rating board followed by its rating, e.g. "PEGI 12" (Europe, ages 12 and up), "BBFC 15" (UK, ages 15 and up), "ESRB T" (North America, Teen, ages 13 and up) or "CERO B" (Japan, ages 12 and up). Each region's board has its own scale, and Kodi doesn't convert between them.
- Parameters
-
| ageRating | string - age rating. |
- v23 Python API changes
- New function added.
◆ setTrailer()
Function: setTrailer(trailer)
Sets the path or URL of the game's trailer.
- Parameters
-
| trailer | string - trailer path or URL. |
- v23 Python API changes
- New function added.
◆ setTags()
1.12.0