Class Game
Represents Playnite game object.
Namespace: PlayniteSDKModels
Inherited members
Constructors
| Improve this Doc View SourceGame()
Creates new instance of a Game object.
Game(string)
Creates new instance of a Game object with specific name.
Parameters
Type | Name | Description |
---|---|---|
string | name | Game name. |
Properties
| Improve this Doc View SourceAdded
Gets or sets date when game was added to library.
Property Value
Type | Description |
---|---|
System.DateTime |
AddedSegment
Gets time segment for games added date.
Property Value
Type | Description |
---|---|
PastTimeSegment |
AgeRatingIds
Gets or sets age rating for a game.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
AgeRatings
Gets game's age rating.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>AgeRating |
BackgroundImage
Gets or sets background image. Local file path, HTTP URL or database file ids are supported.
Property Value
Type | Description |
---|---|
string |
Categories
Gets game's categories.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Category |
CategoryIds
Gets or sets game categories.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
CommunityScore
Gets or sets community rating score.
Property Value
Type | Description |
---|---|
int |
CommunityScoreGroup
Gets game's community score group.
Property Value
Type | Description |
---|---|
ScoreGroup |
CommunityScoreRating
Gets game's community score rating.
Property Value
Type | Description |
---|---|
ScoreRating |
CompletionStatus
Gets game's completion status.
Property Value
Type | Description |
---|---|
CompletionStatus |
CompletionStatusId
Gets or sets game completion status.
Property Value
Type | Description |
---|---|
System.Guid |
CoverImage
Gets or sets game cover image. Local file path, HTTP URL or database file ids are supported.
Property Value
Type | Description |
---|---|
string |
CriticScore
Gets or sets critic based rating score.
Property Value
Type | Description |
---|---|
int |
CriticScoreGroup
Gets game's critic score group.
Property Value
Type | Description |
---|---|
ScoreGroup |
CriticScoreRating
Gets game's critic score rating.
Property Value
Type | Description |
---|---|
ScoreRating |
Description
Gets or sets HTML game description.
Property Value
Type | Description |
---|---|
string |
DeveloperIds
Gets or sets list of developers.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Developers
Gets game's developers.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Company |
EnableSystemHdr
Gets or sets value indicating if the game is should enable HDR on the primary monitor while playing.
Property Value
Type | Description |
---|---|
bool |
Favorite
Gets or sets value indicating if the game is marked as favorite in library.
Property Value
Type | Description |
---|---|
bool |
FeatureIds
Gets or sets list of game features.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Features
Gets game's features.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>GameFeature |
GameActions
Gets or sets list of additional game actions.
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<T>GameAction |
GameId
Gets or sets provider id. For example game's Steam ID.
Property Value
Type | Description |
---|---|
string |
GameStartedScript
Gets or sets script to be executed after game started.
Property Value
Type | Description |
---|---|
string |
GenreIds
Gets or sets list of genres.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Genres
Gets game's genres.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Genre |
Hidden
Gets or sets value indicating if the game is hidden in library.
Property Value
Type | Description |
---|---|
bool |
Icon
Gets or sets game icon. Local file path, HTTP URL or database file ids are supported.
Property Value
Type | Description |
---|---|
string |
IncludeLibraryPluginAction
Gets or sets id of plugin responsible for handling this game.
Property Value
Type | Description |
---|---|
bool |
InstallationStatus
Gets game installation state.
Property Value
Type | Description |
---|---|
InstallationStatus |
InstallDirectory
Gets or sets game installation directory path.
Property Value
Type | Description |
---|---|
string |
InstallSize
Gets or sets the install size in bytes of the game.
Property Value
Type | Description |
---|---|
ulong |
InstallSizeGroup
Gets game's install size group.
Property Value
Type | Description |
---|---|
InstallSizeGroup |
IsCustomGame
Gets value indicating whether the game is custom game.
Property Value
Type | Description |
---|---|
bool |
IsInstalled
Gets or sets value indicating whether a game is installed.
Property Value
Type | Description |
---|---|
bool |
IsInstalling
Gets or sets value indicating whether a game is being installed.
Property Value
Type | Description |
---|---|
bool |
IsLaunching
Gets or sets value indicating whether a game is being launched.
Property Value
Type | Description |
---|---|
bool |
IsRunning
Gets or sets value indicating whether a game is currently running.
Property Value
Type | Description |
---|---|
bool |
IsUninstalling
Gets or sets value indicating whether a game is being uninstalled.
Property Value
Type | Description |
---|---|
bool |
LastActivity
Gets or sets last played date.
Property Value
Type | Description |
---|---|
System.DateTime |
LastActivitySegment
Gets time segment for games last activity.
Property Value
Type | Description |
---|---|
PastTimeSegment |
LastSizeScanDate
Gets or sets date of last date of install size scan made to a game.
Property Value
Type | Description |
---|---|
System.DateTime |
Links
Gets or sets list of game related web links.
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<T>Link |
Manual
Gets or sets game manual.
Property Value
Type | Description |
---|---|
string |
Modified
Gets or sets date of last modification made to a game.
Property Value
Type | Description |
---|---|
System.DateTime |
ModifiedSegment
Gets time segment for games modified date..
Property Value
Type | Description |
---|---|
PastTimeSegment |
Notes
Gets or sets user notes.
Property Value
Type | Description |
---|---|
string |
OverrideInstallState
Gets or sets value indicating whether installation state set by integration plugin should be ignored.
Property Value
Type | Description |
---|---|
bool |
PlatformIds
Gets or sets platform id.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Platforms
Gets game's platform.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Platform |
PlayCount
Gets or sets a number indicating how many times the game has been played.
Property Value
Type | Description |
---|---|
ulong |
Playtime
Gets or sets played time in seconds.
Property Value
Type | Description |
---|---|
ulong |
PlaytimeCategory
Gets game's play time category.
Property Value
Type | Description |
---|---|
PlaytimeCategory |
PluginId
Gets or sets id of plugin responsible for handling this game.
Property Value
Type | Description |
---|---|
System.Guid |
PostScript
Gets or sets post-action script.
Property Value
Type | Description |
---|---|
string |
PreScript
Gets or sets pre-action script.
Property Value
Type | Description |
---|---|
string |
PublisherIds
Gets or sets list of publishers.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Publishers
Gets game's publishers.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Company |
RecentActivity
Gets the most recent date between the last played and added dates.
Property Value
Type | Description |
---|---|
System.DateTime |
RecentActivitySegment
Gets time segment for games recent activity.
Property Value
Type | Description |
---|---|
PastTimeSegment |
RegionIds
Gets or sets game region.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Regions
Gets game's region.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Region |
ReleaseDate
Gets or set game's release date.
Property Value
Type | Description |
---|---|
ReleaseDate |
ReleaseYear
Gets game's release year.
Property Value
Type | Description |
---|---|
int |
Roms
Gets or sets list of game ROM files.
Property Value
Type | Description |
---|---|
System.Collections.ObjectModel.ObservableCollection<T>GameRom |
Series
Gets game's series.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Series |
SeriesIds
Gets or sets game series.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
SortingName
Gets or sets optional name used for sorting the game by name.
Property Value
Type | Description |
---|---|
string |
Source
Gets game's source.
Property Value
Type | Description |
---|---|
GameSource |
SourceId
Gets or sets source of the game.
Property Value
Type | Description |
---|---|
System.Guid |
TagIds
Gets or sets list of tags.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>System.Guid |
Tags
Gets game's tags.
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<T>Tag |
UseGlobalGameStartedScript
Gets or sets value indicating whether global pre script should be executed.
Property Value
Type | Description |
---|---|
bool |
UseGlobalPostScript
Gets or sets value indicating whether global post script should be executed.
Property Value
Type | Description |
---|---|
bool |
UseGlobalPreScript
Gets or sets value indicating whether global pre script should be executed.
Property Value
Type | Description |
---|---|
bool |
UserScore
Gets or sets user's rating score.
Property Value
Type | Description |
---|---|
int |
UserScoreGroup
Gets game's user score group.
Property Value
Type | Description |
---|---|
ScoreGroup |
UserScoreRating
Gets game's user score rating.
Property Value
Type | Description |
---|---|
ScoreRating |
Version
Gets or sets game version.
Property Value
Type | Description |
---|---|
string |
Methods
| Improve this Doc View SourceCopyDiffTo(object)
Copies differential properties to target object intance.
Parameters
Type | Name | Description |
---|---|---|
object | target | Target object instance to receive new data. |
Overrides
| Improve this Doc View SourceGetCopy()
Returns
Type | Description |
---|---|
Game |
GetDifferences(Game)
Gets differences in game objects.
Parameters
Type | Name | Description |
---|---|---|
Game | otherGame | Game object to compare to. |
Returns
Type | Description |
---|---|
System.Collections.Generic.List<T>GameField | List of fields that differ. |
GetGameRecentActivity()
Gets the most recent date between the last played and added dates.
Returns
Type | Description |
---|---|
System.DateTime |
GetInstallDrive()
Gets game Install Drive.
Returns
Type | Description |
---|---|
string |
GetInstallDriveGroup()
Gets game Install Drive group.
Returns
Type | Description |
---|---|
string |
GetInstallSizeGroup()
Gets game Install Size group.
Returns
Type | Description |
---|---|
InstallSizeGroup |
GetNameGroup()
Returns
Type | Description |
---|---|
char |
ToString()
Returns
Type | Description |
---|---|
string |