Show / Hide Table of Contents

    Class Game

    Represents Playnite game object.

    Namespace: PlayniteSDKModels

    Inherited members

    Id
    Name
    CompareTo(object)
    Equals(object)
    GetHashCode()
    PropertyChanged
    OnPropertyChanged(string)
    SetValue<T>(ref T, T, string)
    SetValue<T>(ref T, T, params string[])
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetType()
    object.MemberwiseClone()

    Constructors

    | Improve this Doc View Source

    Game()

    Creates new instance of a Game object.

    | Improve this Doc View Source

    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 Source

    Added

    Gets or sets date when game was added to library.

    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    AddedSegment

    Gets time segment for games added date.

    Property Value
    Type Description
    PastTimeSegment
    | Improve this Doc View Source

    AgeRatingIds

    Gets or sets age rating for a game.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    AgeRatings

    Gets game's age rating.

    Property Value
    Type Description
    System.Collections.Generic.List<T>AgeRating
    | Improve this Doc View Source

    BackgroundImage

    Gets or sets background image. Local file path, HTTP URL or database file ids are supported.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    Categories

    Gets game's categories.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Category
    | Improve this Doc View Source

    CategoryIds

    Gets or sets game categories.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    CommunityScore

    Gets or sets community rating score.

    Property Value
    Type Description
    int
    | Improve this Doc View Source

    CommunityScoreGroup

    Gets game's community score group.

    Property Value
    Type Description
    ScoreGroup
    | Improve this Doc View Source

    CommunityScoreRating

    Gets game's community score rating.

    Property Value
    Type Description
    ScoreRating
    | Improve this Doc View Source

    CompletionStatus

    Gets game's completion status.

    Property Value
    Type Description
    CompletionStatus
    | Improve this Doc View Source

    CompletionStatusId

    Gets or sets game completion status.

    Property Value
    Type Description
    System.Guid
    | Improve this Doc View Source

    CoverImage

    Gets or sets game cover image. Local file path, HTTP URL or database file ids are supported.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    CriticScore

    Gets or sets critic based rating score.

    Property Value
    Type Description
    int
    | Improve this Doc View Source

    CriticScoreGroup

    Gets game's critic score group.

    Property Value
    Type Description
    ScoreGroup
    | Improve this Doc View Source

    CriticScoreRating

    Gets game's critic score rating.

    Property Value
    Type Description
    ScoreRating
    | Improve this Doc View Source

    Description

    Gets or sets HTML game description.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    DeveloperIds

    Gets or sets list of developers.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Developers

    Gets game's developers.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Company
    | Improve this Doc View Source

    EnableSystemHdr

    Gets or sets value indicating if the game is should enable HDR on the primary monitor while playing.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    Favorite

    Gets or sets value indicating if the game is marked as favorite in library.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    FeatureIds

    Gets or sets list of game features.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Features

    Gets game's features.

    Property Value
    Type Description
    System.Collections.Generic.List<T>GameFeature
    | Improve this Doc View Source

    GameActions

    Gets or sets list of additional game actions.

    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<T>GameAction
    | Improve this Doc View Source

    GameId

    Gets or sets provider id. For example game's Steam ID.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    GameStartedScript

    Gets or sets script to be executed after game started.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    GenreIds

    Gets or sets list of genres.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Genres

    Gets game's genres.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Genre
    | Improve this Doc View Source

    Hidden

    Gets or sets value indicating if the game is hidden in library.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    Icon

    Gets or sets game icon. Local file path, HTTP URL or database file ids are supported.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    IncludeLibraryPluginAction

    Gets or sets id of plugin responsible for handling this game.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    InstallationStatus

    Gets game installation state.

    Property Value
    Type Description
    InstallationStatus
    | Improve this Doc View Source

    InstallDirectory

    Gets or sets game installation directory path.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    InstallSize

    Gets or sets the install size in bytes of the game.

    Property Value
    Type Description
    ulong
    | Improve this Doc View Source

    InstallSizeGroup

    Gets game's install size group.

    Property Value
    Type Description
    InstallSizeGroup
    | Improve this Doc View Source

    IsCustomGame

    Gets value indicating whether the game is custom game.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    IsInstalled

    Gets or sets value indicating whether a game is installed.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    IsInstalling

    Gets or sets value indicating whether a game is being installed.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    IsLaunching

    Gets or sets value indicating whether a game is being launched.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    IsRunning

    Gets or sets value indicating whether a game is currently running.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    IsUninstalling

    Gets or sets value indicating whether a game is being uninstalled.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    LastActivity

    Gets or sets last played date.

    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    LastActivitySegment

    Gets time segment for games last activity.

    Property Value
    Type Description
    PastTimeSegment
    | Improve this Doc View Source

    LastSizeScanDate

    Gets or sets date of last date of install size scan made to a game.

    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    Links

    Gets or sets list of game related web links.

    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<T>Link
    | Improve this Doc View Source

    Manual

    Gets or sets game manual.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    Modified

    Gets or sets date of last modification made to a game.

    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    ModifiedSegment

    Gets time segment for games modified date..

    Property Value
    Type Description
    PastTimeSegment
    | Improve this Doc View Source

    Notes

    Gets or sets user notes.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    OverrideInstallState

    Gets or sets value indicating whether installation state set by integration plugin should be ignored.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    PlatformIds

    Gets or sets platform id.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Platforms

    Gets game's platform.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Platform
    | Improve this Doc View Source

    PlayCount

    Gets or sets a number indicating how many times the game has been played.

    Property Value
    Type Description
    ulong
    | Improve this Doc View Source

    Playtime

    Gets or sets played time in seconds.

    Property Value
    Type Description
    ulong
    | Improve this Doc View Source

    PlaytimeCategory

    Gets game's play time category.

    Property Value
    Type Description
    PlaytimeCategory
    | Improve this Doc View Source

    PluginId

    Gets or sets id of plugin responsible for handling this game.

    Property Value
    Type Description
    System.Guid
    | Improve this Doc View Source

    PostScript

    Gets or sets post-action script.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    PreScript

    Gets or sets pre-action script.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    PublisherIds

    Gets or sets list of publishers.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Publishers

    Gets game's publishers.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Company
    | Improve this Doc View Source

    RecentActivity

    Gets the most recent date between the last played and added dates.

    Property Value
    Type Description
    System.DateTime
    | Improve this Doc View Source

    RecentActivitySegment

    Gets time segment for games recent activity.

    Property Value
    Type Description
    PastTimeSegment
    | Improve this Doc View Source

    RegionIds

    Gets or sets game region.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Regions

    Gets game's region.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Region
    | Improve this Doc View Source

    ReleaseDate

    Gets or set game's release date.

    Property Value
    Type Description
    ReleaseDate
    | Improve this Doc View Source

    ReleaseYear

    Gets game's release year.

    Property Value
    Type Description
    int
    | Improve this Doc View Source

    Roms

    Gets or sets list of game ROM files.

    Property Value
    Type Description
    System.Collections.ObjectModel.ObservableCollection<T>GameRom
    | Improve this Doc View Source

    Series

    Gets game's series.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Series
    | Improve this Doc View Source

    SeriesIds

    Gets or sets game series.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    SortingName

    Gets or sets optional name used for sorting the game by name.

    Property Value
    Type Description
    string
    | Improve this Doc View Source

    Source

    Gets game's source.

    Property Value
    Type Description
    GameSource
    | Improve this Doc View Source

    SourceId

    Gets or sets source of the game.

    Property Value
    Type Description
    System.Guid
    | Improve this Doc View Source

    TagIds

    Gets or sets list of tags.

    Property Value
    Type Description
    System.Collections.Generic.List<T>System.Guid
    | Improve this Doc View Source

    Tags

    Gets game's tags.

    Property Value
    Type Description
    System.Collections.Generic.List<T>Tag
    | Improve this Doc View Source

    UseGlobalGameStartedScript

    Gets or sets value indicating whether global pre script should be executed.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    UseGlobalPostScript

    Gets or sets value indicating whether global post script should be executed.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    UseGlobalPreScript

    Gets or sets value indicating whether global pre script should be executed.

    Property Value
    Type Description
    bool
    | Improve this Doc View Source

    UserScore

    Gets or sets user's rating score.

    Property Value
    Type Description
    int
    | Improve this Doc View Source

    UserScoreGroup

    Gets game's user score group.

    Property Value
    Type Description
    ScoreGroup
    | Improve this Doc View Source

    UserScoreRating

    Gets game's user score rating.

    Property Value
    Type Description
    ScoreRating
    | Improve this Doc View Source

    Version

    Gets or sets game version.

    Property Value
    Type Description
    string

    Methods

    | Improve this Doc View Source

    CopyDiffTo(object)

    Copies differential properties to target object intance.

    Parameters
    Type Name Description
    object target

    Target object instance to receive new data.

    Overrides
    DatabaseObject.CopyDiffTo(object)
    | Improve this Doc View Source

    GetCopy()

    Returns
    Type Description
    Game
    | Improve this Doc View Source

    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.

    | Improve this Doc View Source

    GetGameRecentActivity()

    Gets the most recent date between the last played and added dates.

    Returns
    Type Description
    System.DateTime
    | Improve this Doc View Source

    GetInstallDrive()

    Gets game Install Drive.

    Returns
    Type Description
    string
    | Improve this Doc View Source

    GetInstallDriveGroup()

    Gets game Install Drive group.

    Returns
    Type Description
    string
    | Improve this Doc View Source

    GetInstallSizeGroup()

    Gets game Install Size group.

    Returns
    Type Description
    InstallSizeGroup
    | Improve this Doc View Source

    GetNameGroup()

    Returns
    Type Description
    char
    | Improve this Doc View Source

    ToString()

    Returns
    Type Description
    string
    Overrides
    DatabaseObject.ToString()

    Implements

    System.ComponentModel.INotifyPropertyChanged
    System.IComparable
    IIdentifiable
    • Improve this Doc
    • View Source
    Back to top Generated by DocFX