Hand (fireworks 0.2.2-SNAPSHOT API)

All Superinterfaces:

Serializable

All Known Implementing Classes:

BasicHand, NegativeHand, ShieldedHand, TimedHand
```
public interface Hand
extends Serializable
```
Created by webpigeon on 18/10/16.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`bindCard(int slot, Card card)` Bind a card to a given slot, keeping all known information about it.
`Card`	`getCard(int slot)` Get the card really present in the slot (or null if unknown).
`CardColour`	`getKnownColour(int slot)` Get the known colour of this slot, from the perspective of the player who's hand it is.
`Integer`	`getKnownValue(int slot)` Get the known value of this slot, from the perspective of the player who's hand it is.
`CardColour[]`	`getPossibleColours(int slot)` get possible colours for a given slot.
`int[]`	`getPossibleValues(int slot)` get possible values for a given slot.
`int`	`getSize()` The number of cards which make up this hand.
`boolean`	`hasCard(int slot)` Does the hand contain a card in this slot?
`boolean`	`hasColour(CardColour colour)` Has a card of that colour that it knows exactly about
`boolean`	`hasValue(Integer value)` Has a card of that value that it knows exactly about
`void`	`init()` Initialise all information about the slots.
`boolean`	`isCompletePossible(int slot, Card card)` Check if this card is possible based on complete infomation.
`boolean`	`isPossible(int slot, Card card)` check if the card is possible, based on the owner's prespective
`void`	`setCard(int slot, Card card)` Set a card in a given slot, removing all known information about it.
`void`	`setHasCard(int slot, boolean value)` Sets whether the hand has a card in this slot.
`void`	`setKnownColour(CardColour colour, Integer[] slots)` Sets the known colour of a slot from the perspective of the owner.
`void`	`setKnownValue(Integer value, Integer[] slots)` Sets the known value of a slot from the perspective of the owner.

- Method Detail
  - init
```
void init()
```
    Initialise all information about the slots.
    This should reset any known infomation for any slot in the hand.
  - getCard
```
Card getCard(int slot)
```
    Get the card really present in the slot (or null if unknown).
    This is the card which is present in the slot based on information provided by the game itself. This method should always return null for your own hand (agents should not call this method on their own hands).
    Agents can use this for accurate information about other player's hands.
    
    Parameters:
    
    slot - the slot to query
    
    Returns:
    
    the card present in that slot, or null if the card is unknown.
  - getKnownColour
```
CardColour getKnownColour(int slot)
```
    Get the known colour of this slot, from the perspective of the player who's hand it is.
    For this version of the hand class, this is worked out based on explicitly observed tell actions. It will not take into account negative information.
    
    Parameters:
    
    slot - the slot to query
    
    Returns:
    
    the colour of the slot, from the owner's perspective.
  - getKnownValue
```
Integer getKnownValue(int slot)
```
    Get the known value of this slot, from the perspective of the player who's hand it is.
    For this version of the hand class, this is worked out based on explicitly observed tell actions. It will not take into account negative information.
    
    Parameters:
    
    slot - the slot to query
    
    Returns:
    
    the value of the slot, from the owner's perspective.
  - getSize
```
int getSize()
```
    The number of cards which make up this hand.
    This can very with game size, and so this should be used whenever you need to iterate over the number of slots in this player's hand.
    
    Returns:
    
    the number of slots in this player's hand.
  - setCard
```
void setCard(int slot,
             Card card)
```
    Set a card in a given slot, removing all known information about it.
    This should be called when a CardDrawn event occurs in order to update this hand with the correct information.
    It will also reset all known information from the perspective of the owner.
    
    Parameters:
    
    slot - the slot to update
    
    card - the card now residing in this slot
  - bindCard
```
void bindCard(int slot,
              Card card)
```
    Bind a card to a given slot, keeping all known information about it.
    This has the same basic role as setCard(int, com.fossgalaxy.games.fireworks.state.Card) but will not remove any information from the owners perspective. This is mostly useful when using this class as part of a simulation based agent to set the value of the card.
    
    Parameters:
    
    slot - the slot to update
    
    card - the card to assign to that slot
  - setKnownColour
```
void setKnownColour(CardColour colour,
                    Integer[] slots)
```
    Sets the known colour of a slot from the perspective of the owner.
    This method is used to inform the hand about the card from the owner's perspective (tell actions).
    
    Parameters:
    
    colour - the colour to assign to the slots
    
    slots - the slots to assign the colour to.
  - setKnownValue
```
void setKnownValue(Integer value,
                   Integer[] slots)
```
    Sets the known value of a slot from the perspective of the owner.
    This method is used to inform the hand about the card from the owner's perspective (tell actions).
    
    Parameters:
    
    value - the value to assign to the slots
    
    slots - the slots to assign the value to.
  - isCompletePossible
```
boolean isCompletePossible(int slot,
                           Card card)
```
    Check if this card is possible based on complete infomation.
    
    Parameters:
    
    slot - the slot to check
    
    card - the card we are considering
    
    Returns:
    
    true if this card could possibly be in this slot, else return false
  - isPossible
```
boolean isPossible(int slot,
                   Card card)
```
    check if the card is possible, based on the owner's prespective
    
    Parameters:
    
    slot - the slot to check
    
    card - the card we are considering
    
    Returns:
    
    true if this card could possibly fit in this slow, false otherwise.
  - getPossibleValues
```
int[] getPossibleValues(int slot)
```
    get possible values for a given slot.
    
    Parameters:
    
    slot - the slot to check
    
    Returns:
    
    all possible value for this slot
  - getPossibleColours
```
CardColour[] getPossibleColours(int slot)
```
    get possible colours for a given slot.
    
    Parameters:
    
    slot - the slot to check
    
    Returns:
    
    all possible colour for this slot
  - hasColour
```
boolean hasColour(CardColour colour)
```
    Has a card of that colour that it knows exactly about
    
    Parameters:
    
    colour - The colour to check
    
    Returns:
    
    Wether there is a card of that colour in the hand
  - hasValue
```
boolean hasValue(Integer value)
```
    Has a card of that value that it knows exactly about
    
    Parameters:
    
    value - The value to check
    
    Returns:
    
    Wether there is a card of that value in the hand
  - hasCard
```
boolean hasCard(int slot)
```
    Does the hand contain a card in this slot?
    
    Parameters:
    
    slot - The slot to check
    
    Returns:
    
    Whether there is a card in the slot
  - setHasCard
```
void setHasCard(int slot,
                boolean value)
```
    Sets whether the hand has a card in this slot.
    
    Parameters:
    
    slot - The slot to set
    
    value - The presence or not of a card

Interface Hand

Method Summary

Method Detail

init

getCard

getKnownColour

getKnownValue

getSize

setCard

bindCard

setKnownColour

setKnownValue

isCompletePossible

isPossible

getPossibleValues

getPossibleColours

hasColour

hasValue

hasCard

setHasCard