Inheritance diagram for Location:

Public Member Functions
	Location (Card ownerCard, LocationName name)

	Location (SerializationInfo info, StreamingContext context)

	Location (TurnTaker ownerTurnTaker, LocationName name, string subDeckName=null, string identifier=null)

void	AddCard (Card card, bool toEnd=false, int offset=0)

IEnumerable< Card >	GetBottomCards (int numberOfCards)

string	GetFriendlyName ()

void	GetObjectData (SerializationInfo info, StreamingContext context)

string	GetOwnerName ()

IEnumerable< Card >	GetTopCards (int numberOfCards)

IEnumerable< Card >	GetTopCards (int numberOfCards, Func< Card, bool > cardCriteria)
	Used to get the top cards of a location that match a specific criteria.

bool	HasCard (Card card)

bool	IsPlayAreaOf (TurnTaker tt)
	Returns whether or not this location is in the play area of the provided turn taker. For example, this would return true if it were that turn taker's play area, or next to/under a card in that play area.

void	RemoveCard (Card card)

void	ShuffleCards ()

override string	ToString ()

Properties
BattleZone	BattleZone `[get]`

Card	BottomCard `[get]`

IEnumerable< Card >	Cards `[get]`

Game	Game `[get]`

bool	HasCards `[get]`

Location	HighestRecursiveLocation `[get]`
	Looks up chain of locations until it reaches the highest ex. PlayArea/Deck/Trash.

string	Identifier `[get]`

bool	IsBelowCard `[get]`

bool	IsDeck `[get]`
	This is true if the location is either a Deck or a Subdeck.

bool	IsEmpty `[get]`

bool	IsEnvironment `[get]`

bool	IsHand `[get]`

bool	IsHero `[get]`

bool	IsHeroPlayAreaRecursive `[get]`
	Returns true if this is a hero play area or a "next to" location within a hero play area.

bool	IsInGame `[get]`

bool	IsInPlay `[get]`

bool	IsInPlayAndNotUnderCard `[get]`

bool	IsInTheBox `[get]`
	Gets a value indicating whether this location is the InTheBox location.

bool	IsNextToCard `[get]`

bool	IsOffToTheSide `[get]`

bool	IsOutOfGame `[get]`
	Gets a value indicating whether this location is the OutOfGame location.

bool	IsPlayArea `[get]`

bool	IsRealDeck `[get]`

bool	IsRealTrash `[get]`

bool	IsRevealed `[get]`

bool	IsSubDeck `[get]`

bool	IsSubLocation `[get]`

bool	IsSubPlayArea `[get]`

bool	IsSubTrash `[get]`

bool	IsTrash `[get]`
	This is true if the location is either a Trash or a Subtrash.

bool	IsUnderCard `[get]`

bool	IsVillain `[get]`

LocationName	Name `[get]`

int	NumberOfCards `[get]`

bool?	OverrideIsInPlay `[get, set]`
	Set this value to override the IsInPlay property to a specific value.

Card	OwnerCard `[get]`

string	OwnerName `[get]`

TurnTaker	OwnerTurnTaker `[get]`

int	ShuffleCount `[get]`

string	SubDeckName `[get]`

Card	TopCard `[get]`

Member Function Documentation

◆ GetTopCards()

IEnumerable< Card > GetTopCards	(	int	numberOfCards,
		Func< Card, bool >	cardCriteria )

inline

Used to get the top cards of a location that match a specific criteria.

Parameters

numberOfCards	The number of cards to get from the top of the location
cardCriteria	The criteria for the cards that will be checked

Returns: The passed in number of cards matching the criteria that are closest to the top

Property Documentation

◆ IsInTheBox

bool IsInTheBox

get

Gets a value indicating whether this location is the InTheBox location.

true if is in the box; otherwise, false.

◆ IsOutOfGame

bool IsOutOfGame

get

Gets a value indicating whether this location is the OutOfGame location.

true if is out of game; otherwise, false.

Public Member Functions

Properties

Member Function Documentation

◆ GetTopCards()

Property Documentation

◆ IsInTheBox

◆ IsOutOfGame