LaunchBoxContributors
On this page

IPlaylistFilter7.10

Interface in Unbroken.LaunchBox.Plugins.Data

C#
public interface IPlaylistFilter
Describes one comparison used to populate a playlist automatically.

Properties

  • ComparisonTypeKeyGets or sets the stable comparison key used to evaluate the playlist filter.
  • FieldKeyGets or sets the stable game-field key evaluated by the playlist filter.
  • PlaylistIdGets the playlist identifier.
  • ValueGets or sets the comparison value used by the playlist filter.

ComparisonTypeKey

C#
string ComparisonTypeKey { get; set; }
Gets or sets the stable comparison key used to evaluate the playlist filter.

FieldKey

C#
string FieldKey { get; set; }
Gets or sets the stable game-field key evaluated by the playlist filter.

PlaylistId

C#
string PlaylistId { get; }
Gets the playlist identifier.

Value

C#
string Value { get; set; }
Gets or sets the comparison value used by the playlist filter.

Methods

  • GetMatchesEvaluates this playlist filter against a game.

GetMatches

C#
bool GetMatches(IGame game)
Evaluates this playlist filter against a game.
game
The game to evaluate.

Returns

Whether the game satisfies this comparison.