ColorShapeLinks
An assignment for the AI course unit of the Bachelor in Videogames at Lusófona University
ISessionDataProvider Interface Reference

Defines a data provider for ColorShapeLinks sessions, which include one or more matches. More...

Inheritance diagram for ISessionDataProvider:
Inheritance graph
Collaboration diagram for ISessionDataProvider:
Collaboration graph

Properties

SessionState State [get]
 State of the current session. More...
 
string PlayerWhite [get]
 Name of player playing as white. More...
 
string PlayerRed [get]
 Name of player playing as red. More...
 
IEnumerable< MatchMatches [get]
 All matches played or to be played in current session. More...
 
IEnumerable< KeyValuePair< Match, Winner > > Results [get]
 Results of matches played so far in current session. More...
 
IEnumerable< KeyValuePair< IPlayer, int > > Standings [get]
 Standings (classification, ranking) of players in current session. More...
 
Winner LastMatchResult [get]
 Result of last match. More...
 
string WinnerString [get]
 The winner's name and color. More...
 
bool WhoPlaysFirst [get]
 Ask who plays first? More...
 
bool BlockStartNextMatch [get]
 Start of next match screen needs to be unlocked with a button? More...
 
bool BlockShowResult [get]
 Show result screen needs to be unlocked with a button? More...
 
float UnblockedScreenDuration [get]
 Duration of unblocked screens (start of next match, show result). More...
 

Detailed Description

Defines a data provider for ColorShapeLinks sessions, which include one or more matches.

Definition at line 14 of file ISessionDataProvider.cs.

Property Documentation

◆ BlockShowResult

bool BlockShowResult
get

Show result screen needs to be unlocked with a button?

true if show result screen needs to be unlocked with a button, false otherwise.

Definition at line 78 of file ISessionDataProvider.cs.

◆ BlockStartNextMatch

bool BlockStartNextMatch
get

Start of next match screen needs to be unlocked with a button?

true if start of next match screen needs to be unlocked with a button, false otherwise.

Definition at line 69 of file ISessionDataProvider.cs.

◆ LastMatchResult

Winner LastMatchResult
get

Result of last match.

One of the values of the Winner enumeration.

Definition at line 50 of file ISessionDataProvider.cs.

◆ Matches

IEnumerable<Match> Matches
get

All matches played or to be played in current session.

Collection of matches.

Definition at line 34 of file ISessionDataProvider.cs.

◆ PlayerRed

string PlayerRed
get

Name of player playing as red.

A string containing the player's name.

Definition at line 28 of file ISessionDataProvider.cs.

◆ PlayerWhite

string PlayerWhite
get

Name of player playing as white.

A string containing the player's name.

Definition at line 24 of file ISessionDataProvider.cs.

◆ Results

IEnumerable<KeyValuePair<Match, Winner> > Results
get

Results of matches played so far in current session.

Collection of match-winner pairs.

Definition at line 38 of file ISessionDataProvider.cs.

◆ Standings

IEnumerable<KeyValuePair<IPlayer, int> > Standings
get

Standings (classification, ranking) of players in current session.

Descending ordered collection of player-points pairs.

Definition at line 44 of file ISessionDataProvider.cs.

◆ State

SessionState State
get

State of the current session.

One of the values defined in the SessionState enumeration.

Definition at line 20 of file ISessionDataProvider.cs.

◆ UnblockedScreenDuration

float UnblockedScreenDuration
get

Duration of unblocked screens (start of next match, show result).

Duration in seconds.

Definition at line 84 of file ISessionDataProvider.cs.

◆ WhoPlaysFirst

bool WhoPlaysFirst
get

Ask who plays first?

true if UI is to ask who plays first, false otherwise.

Definition at line 60 of file ISessionDataProvider.cs.

◆ WinnerString

string WinnerString
get

The winner's name and color.

A string containing the winner's name and color.

Definition at line 54 of file ISessionDataProvider.cs.


The documentation for this interface was generated from the following file: