SotM Engine API
Class documentation for the Sentinels of the Multiverse Engine API.
Loading...
Searching...
No Matches
Journal Class Reference

Public Member Functions

 Journal (Game game)
 
IEnumerable< ActivateAbilityJournalEntryActivateAbilityEntries ()
 
IEnumerable< T > AllJournalEntries< T > (bool suppressWarnings=false)
 
IEnumerable< BulkMoveCardsJournalEntryBulkMoveCardsEntriesOnTurn (int turnIndex)
 
IEnumerable< BulkMoveCardsJournalEntryBulkMoveCardsEntriesThisTurn ()
 
IEnumerable< CardEntersPlayJournalEntryCardEntersPlayEntries ()
 
IEnumerable< CardEntersPlayJournalEntryCardEntersPlayEntriesOnTurn (int turnIndex)
 
IEnumerable< CardEntersPlayJournalEntryCardEntersPlayEntriesThisRound ()
 
IEnumerable< CardEntersPlayJournalEntryCardEntersPlayEntriesThisTurn ()
 
IEnumerable< MoveCardJournalEntryCardLeavesPlayEntries ()
 
IEnumerable< MoveCardJournalEntryCardLeavesPlayEntriesOnTurn (int turnIndex)
 
IEnumerable< MoveCardJournalEntryCardLeavesPlayEntriesThisRound ()
 
IEnumerable< MoveCardJournalEntryCardLeavesPlayEntriesThisTurn ()
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntries (Func< CardPropertiesJournalEntry, bool > cardPropertiesCriteria)
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntriesOnTurn (Card card, int turnIndex)
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntriesOnTurn (Func< CardPropertiesJournalEntry, bool > cardPropertiesCriteria, int turnIndex)
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntriesThisRound (Func< CardPropertiesJournalEntry, bool > cardPropertiesCriteria)
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntriesThisTurn (Card card)
 
IEnumerable< CardPropertiesJournalEntryCardPropertiesEntriesThisTurn (Func< CardPropertiesJournalEntry, bool > cardPropertiesCriteria)
 
IEnumerable< DealDamageJournalEntryDealDamageEntries ()
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesFromCardToCardOnTurn (Card sourceCard, Card targetCard, int turnIndex)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesFromCardToCardThisTurn (Card sourceCard, Card targetCard)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesFromTargetToTargetSinceLastTurn (Card sourceCard, Card targetCard, TurnTaker turnTaker)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesOnTurn (int turnIndex)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesThisRound ()
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesThisRoundSinceCardWasPlayed (Card card)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesThisTurn ()
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesThisTurnSinceCardWasPlayed (Card card)
 
IEnumerable< DealDamageJournalEntryDealDamageEntriesToTargetSinceLastTurn (Card targetCard, TurnTaker turnTaker)
 
IEnumerable< DecisionAnswerJournalEntryDecisionAnswerEntries (Func< DecisionAnswerJournalEntry, bool > criteria)
 
IEnumerable< DestroyCardJournalEntryDestroyCardEntries ()
 
IEnumerable< DestroyCardJournalEntryDestroyCardEntriesOnTurn (int turnIndex)
 
IEnumerable< DestroyCardJournalEntryDestroyCardEntriesThisRound ()
 
IEnumerable< DestroyCardJournalEntryDestroyCardEntriesThisTurn ()
 
IEnumerable< MoveCardJournalEntryDiscardCardEntries ()
 
IEnumerable< MoveCardJournalEntryDiscardCardEntriesOnTurn (int turnIndex)
 
IEnumerable< MoveCardJournalEntryDiscardCardEntriesSinceLastTurn (TurnTaker turnTaker)
 
IEnumerable< MoveCardJournalEntryDiscardCardEntriesThisTurn ()
 
bool DoesMostRecentDealDamageEntryMatchCriteria (Func< DealDamageJournalEntry, bool > criteria)
 
IEnumerable< DrawCardJournalEntryDrawCardEntries ()
 
IEnumerable< DrawCardJournalEntryDrawCardEntriesOnTurn (int turnIndex)
 
IEnumerable< DrawCardJournalEntryDrawCardEntriesThisTurn ()
 
IEnumerable< FlipCardJournalEntryFlipCardEntries ()
 
IEnumerable< GainHPJournalEntryGainHPEntries ()
 
IEnumerable< GainHPJournalEntryGainHPEntriesOnTurn (int turnIndex)
 
IEnumerable< GainHPJournalEntryGainHPEntriesThisTurn ()
 
bool? GetCardPropertiesBoolean (Card card, string key)
 
Card GetCardPropertiesCard (Card card, string key)
 
int? GetCardPropertiesInteger (Card card, string key)
 
IEnumerable< string > GetCardPropertiesStringList (Card card, string key, bool supressWarnings=false)
 
TurnTaker GetCardPropertiesTurnTaker (Card card, string key)
 
int? GetEntryIndex (JournalEntry entry)
 
JournalEntry GetLastEventInJournal ()
 
IEnumerable< ImmuneToDamageJournalEntryImmuneToDamageEntries (Func< ImmuneToDamageJournalEntry, bool > criteria)
 
IEnumerable< IncreaseDamageJournalEntryIncreaseDamageEntries (Func< IncreaseDamageJournalEntry, bool > criteria)
 
IEnumerable< ModifyTokensJournalEntryModifyTokensEntries ()
 
IEnumerable< ModifyTokensJournalEntryModifyTokensEntriesOnTurn (int turnIndex)
 
IEnumerable< ModifyTokensJournalEntryModifyTokensEntriesThisRound ()
 
IEnumerable< ModifyTokensJournalEntryModifyTokensEntriesThisTurn ()
 
DealDamageJournalEntry MostRecentDealDamageEntry (Func< DealDamageJournalEntry, bool > criteria)
 
DestroyCardJournalEntry MostRecentDestroyCardEntry (Func< DestroyCardJournalEntry, bool > criteria)
 
FlipCardJournalEntry MostRecentFlipCardEntry (Func< FlipCardJournalEntry, bool > criteria)
 
IEnumerable< MoveCardJournalEntryMoveCardEntries ()
 
IEnumerable< MoveCardJournalEntryMoveCardEntriesOnTurn (int turnIndex)
 
IEnumerable< MoveCardJournalEntryMoveCardEntriesThisTurn ()
 
int NumberOfMinionCardsPlayedThisTurn ()
 
Func< T, bool > OnTurn< T > (int turnIndex)
 
IEnumerable< PhaseChangeJournalEntryPhaseChangeEntries ()
 
IEnumerable< PhaseChangeJournalEntryPhaseChangeEntriesOnTurn (int turnIndex)
 
IEnumerable< PhaseChangeJournalEntryPhaseChangeEntriesThisTurn ()
 
IEnumerable< PlayCardJournalEntryPlayCardEntries ()
 
IEnumerable< PlayCardJournalEntryPlayCardEntriesOnTurn (int turnIndex)
 
IEnumerable< PlayCardJournalEntryPlayCardEntriesThisTurn ()
 
IEnumerable< T > QueryJournalEntries< T > (Func< T, bool > criteria)
 
void RecordActivateAbility (Card cardWithAbility, string abilityKey, int abilityIndex, TurnTaker activatingTurnTaker, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordCardEntersPlay (Card cardSource, Card card)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordCardProperties (Card card, string key, bool? boolValue=null)
 
void RecordCardProperties (Card card, string key, Card otherCard)
 
void RecordCardProperties (Card card, string key, IEnumerable< string > list)
 
void RecordCardProperties (Card card, string key, int? intValue=null)
 
void RecordCardProperties (Card card, string key, TurnTaker tt)
 
void RecordChangeMaximumHP (Card targetCard, int amount, bool alsoSetHP)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
DealDamageJournalEntry RecordDealDamage (Card sourceCard, Card targetCard, int amount, DamageType damageType, Card cardThatCausedDamageToOccur, int numberOfTimesRedirected)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
DealDamageJournalEntry RecordDealDamage (TurnTaker sourceTurnTaker, Card targetCard, int amount, DamageType damageType, Card cardThatCausedDamageToOccur, int numberOfTimesRedirected)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordDecisionAnswer (string decisionIdentifier, HeroTurnTaker decisionMaker, int? answerIndex, bool skipped, bool autoDecided, TurnTaker selectedTurnTaker, Card selectedCard, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordDestroyCard (Card cardSource, Card card, Location originalLocation, Location postDestroyLocation, bool wasTargetWhenDestroyed, DealDamageJournalEntry dealDamageEntry, Card responsibleCard, IEnumerable< string > keywords)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordDrawCard (HeroTurnTaker hero, Card card, bool shuffledTrashIntoDeck, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordFlipCard (Card card, Card cardSource, Card damageSource=null)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordGainHP (Card sourceCard, Card targetCard, int amount, int hpAfterGain)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordGameState ()
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
ImmuneToDamageJournalEntry RecordImmuneToDamage (Card fromTarget, Card toTarget, int amountPrevented, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
IncreaseDamageJournalEntry RecordIncreaseDamage (Card sourceCard, Card targetCard, int amountOfDamageIncreased, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordModifyTokens (Card cardSource, TokenPool pool, int beforeAmount, int afterAmount)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordMoveCard (Card cardSource, Card card, Location fromLocation, Location toLocation, bool toBottom, TurnTaker responsibleTurnTaker, bool isDiscard, int? cardSourcePlayIndex, bool shuffledTrashIntoDeck, IEnumerable< string > keywords=null)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordPhaseChange (TurnPhase fromPhase, TurnPhase toPhase, int turnPhaseIndex)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordPlayCard (Card card, TurnTaker responsibleTurnTaker, bool isInitialCard, bool isPutIntoPlay, IEnumerable< string > keywords, int? playIndex, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
RedirectDamageJournalEntry RecordRedirectDamage (Card fromTarget, Card toTarget, int amountRedirected, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
ReduceDamageJournalEntry RecordReduceDamage (Card sourceCard, Card targetCard, int amountOfDamageReduced, bool reducedBecauseTarget, int damageIdentifier, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordSetHP (Card targetCard, int amount, Card cardSource)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordSwitchCard (Card cardSource, Card cardA, Card cardB)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordTargetEntersPlay (Card cardSource, Card target)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordTargetLeavesPlay (Card cardSource, Card target)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordUseIncapacitatedAbility (Card cardWithAbility, int abilityIndex)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
void RecordUsePower (Card cardWithPower, int powerIndex, int numberOfUses, Card cardSource, HeroTurnTaker powerUser, bool isContributionFromCardSource, int? cardWithPowerPlayIndex, int? cardSourcePlayIndex, Card cardThatAllowedPowerToBeUsed, Card heroCharacterCardUsingPower)
 Journal entries are recorded automatically by the GameActions responsible. Do not call this directly!
 
IEnumerable< RedirectDamageJournalEntryRedirectDamageEntries (Func< RedirectDamageJournalEntry, bool > criteria)
 
IEnumerable< ReduceDamageJournalEntryReduceDamageEntries (Func< ReduceDamageJournalEntry, bool > criteria)
 
IEnumerable< ReduceDamageJournalEntryReduceDamageEntriesOnTurn (int turnIndex)
 
IEnumerable< ReduceDamageJournalEntryReduceDamageEntriesThisRound ()
 
IEnumerable< ReduceDamageJournalEntryReduceDamageEntriesThisTurn ()
 
void RemoveCardProperties (Card card, string key)
 
IEnumerable< SetHPJournalEntrySetHPEntries ()
 
Func< T, bool > SinceCardWasMoved< T > (Card card, Func< MoveCardJournalEntry, bool > moveCriteria)
 
Func< T, bool > SinceCardWasPlayed< T > (Card card)
 
Func< T, bool > SinceLastTurn< T > (TurnTaker turnTaker)
 
IEnumerable< SwitchCardJournalEntrySwitchCardEntries ()
 
IEnumerable< SwitchCardJournalEntrySwitchCardEntriesOnTurn (int turnIndex)
 
IEnumerable< SwitchCardJournalEntrySwitchCardEntriesThisTurn ()
 
IEnumerable< TargetJournalEntryTargetEntersOrLeavesEntries ()
 
IEnumerable< TargetJournalEntryTargetEntersOrLeavesEntriesOnTurn (int turnIndex)
 
IEnumerable< TargetJournalEntryTargetEntersOrLeavesEntriesThisRound ()
 
IEnumerable< TargetJournalEntryTargetEntersOrLeavesEntriesThisTurn ()
 
IEnumerable< TargetEntersPlayJournalEntryTargetEntersPlayEntries ()
 
IEnumerable< TargetEntersPlayJournalEntryTargetEntersPlayEntriesOnTurn (int turnIndex)
 
IEnumerable< TargetEntersPlayJournalEntryTargetEntersPlayEntriesThisRound ()
 
IEnumerable< TargetEntersPlayJournalEntryTargetEntersPlayEntriesThisTurn ()
 
IEnumerable< TargetLeavesPlayJournalEntryTargetLeavesPlayEntries ()
 
IEnumerable< TargetLeavesPlayJournalEntryTargetLeavesPlayEntriesOnTurn (int turnIndex)
 
IEnumerable< TargetLeavesPlayJournalEntryTargetLeavesPlayEntriesThisRound ()
 
IEnumerable< TargetLeavesPlayJournalEntryTargetLeavesPlayEntriesThisTurn ()
 
Func< T, bool > ThisRound< T > ()
 
Func< T, bool > ThisTurn< T > ()
 
IEnumerable< UsePowerJournalEntryUsePowerEntries ()
 
IEnumerable< UsePowerJournalEntryUsePowerEntriesOnTurn (int turnIndex)
 
IEnumerable< UsePowerJournalEntryUsePowerEntriesThisTurn ()
 
bool WasCardFlippedOnTurn (Card card, int turnIndex)
 
bool WasCardFlippedThisGame (Card card)
 Returns whether or not the given card has been flipped this game.
 
bool WasCardFlippedThisTurn (Card card)
 

Properties

IEnumerable< JournalEntryEntries [get]
 
Game Game [get]
 
bool Recording [get, set]
 

Member Function Documentation

◆ AllJournalEntries< T >()

IEnumerable< T > AllJournalEntries< T > ( bool suppressWarnings = false)
inline
Type Constraints
T :JournalEntry 

◆ OnTurn< T >()

Func< T, bool > OnTurn< T > ( int turnIndex)
inline
Type Constraints
T :JournalEntry 

◆ QueryJournalEntries< T >()

IEnumerable< T > QueryJournalEntries< T > ( Func< T, bool > criteria)
inline
Type Constraints
T :JournalEntry 

◆ SinceCardWasMoved< T >()

Func< T, bool > SinceCardWasMoved< T > ( Card card,
Func< MoveCardJournalEntry, bool > moveCriteria )
inline
Type Constraints
T :JournalEntry 

◆ SinceCardWasPlayed< T >()

Func< T, bool > SinceCardWasPlayed< T > ( Card card)
inline
Type Constraints
T :JournalEntry 

◆ SinceLastTurn< T >()

Func< T, bool > SinceLastTurn< T > ( TurnTaker turnTaker)
inline
Type Constraints
T :JournalEntry 

◆ ThisRound< T >()

Func< T, bool > ThisRound< T > ( )
inline
Type Constraints
T :JournalEntry 

◆ ThisTurn< T >()

Func< T, bool > ThisTurn< T > ( )
inline
Type Constraints
T :JournalEntry