edu.usc.ict.iago.agent

Class IAGOCoreVH

java.lang.Object

edu.usc.ict.iago.utils.GeneralNegotiator

edu.usc.ict.iago.utils.GeneralVH

edu.usc.ict.iago.agent.IAGOCoreVH

Direct Known Subclasses:

IAGOGastonFavorVH, IAGOGothelFavorVH, IAGOJiminyFavorVH

public abstract class IAGOCoreVH
extends GeneralVH

Field Summary

Fields inherited from class edu.usc.ict.iago.utils.GeneralVH

safeForMultiAgent

Fields inherited from class edu.usc.ict.iago.utils.GeneralNegotiator

game

Constructor Summary

Constructors

Constructor and Description
IAGOCoreVH(java.lang.String name, GameSpec game, javax.websocket.Session session, IAGOCoreBehavior behavior, IAGOCoreExpression expression, IAGOCoreMessage messages) Constructor for most VHs used by IAGO.

Method Summary

Modifier and Type	Method and Description
abstract java.lang.String	getArtName() Every agent needs a name to select the art that will be used.
java.util.LinkedList<Event>	getEventResponse(Event e) Agents work by responding to various events.
protected int	getGameCount() Returns a simple int representing the current game count.
protected int	getLedger() Returns a simple int representing the internal "ledger" of favors done for the agent.
protected int	getTotalLedger() Returns a simple int representing the internal "ledger" of favors done for the agent, including all pending values.
protected int	getVerbalLedger() Returns a simple int representing the potential "ledger" of favors verbally agreed to.
protected void	modifyOfferLedger(int increment) Allows you to modify the agent's internal "ledger" of offer favors proposed.
protected void	modifyVerbalLedger(int increment) Allows you to modify the agent's internal "ledger" of verbal favors done for it.

Methods inherited from class edu.usc.ict.iago.utils.GeneralVH

agentDescription, getAgentVsAgent, getID, safeForMultiAgent, setAgentVsAgent

Methods inherited from class edu.usc.ict.iago.utils.GeneralNegotiator

getAdversary, getHistory, getName, getSession, pairWith, setAdversary, setGameSpec, setHistory

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

IAGOCoreVH

public IAGOCoreVH(java.lang.String name,
                  GameSpec game,
                  javax.websocket.Session session,
                  IAGOCoreBehavior behavior,
                  IAGOCoreExpression expression,
                  IAGOCoreMessage messages)

Constructor for most VHs used by IAGO.

Parameters:

name - name of the agent. NOTE: Please give your agent a unique name. Do not copy from the default names, such as "Pinocchio," or use the name of one of the character models. An agent's name and getArtName do not need to match.

game - the GameSpec that the agent plays in first.

session - the web session that the agent will be active in.

behavior - Every core agent needs a behavior extending CoreBehavior.

expression - Every core agent needs an expression extending CoreExpression.

messages - Every core agent needs a message extending CoreMessage.

Method Detail

getLedger

protected int getLedger()

Returns a simple int representing the internal "ledger" of favors done for the agent. Can be negative. Persists across games.

Returns:

the ledger

getTotalLedger

protected int getTotalLedger()

Returns a simple int representing the internal "ledger" of favors done for the agent, including all pending values. Can be negative. Does not persist across games.

Returns:

the ledger

getVerbalLedger

protected int getVerbalLedger()

Returns a simple int representing the potential "ledger" of favors verbally agreed to. Can be negative. Does not persist across games.

Returns:

the ledger

modifyVerbalLedger

protected void modifyVerbalLedger(int increment)

Allows you to modify the agent's internal "ledger" of verbal favors done for it.

Parameters:

increment - value (negative ok)

modifyOfferLedger

protected void modifyOfferLedger(int increment)

Allows you to modify the agent's internal "ledger" of offer favors proposed.

Parameters:

increment - value (negative ok)

getGameCount

protected int getGameCount()

Returns a simple int representing the current game count.

Returns:

the game number (starting with 1)

getEventResponse

public java.util.LinkedList<Event> getEventResponse(Event e)

Agents work by responding to various events. This method describes how core agents go about selecting their responses.

Specified by:

getEventResponse in class GeneralVH

Parameters:

e - the Event that the agent will respond to.

Returns:

a list of Events in response to the initial Event.

getArtName

public abstract java.lang.String getArtName()

Every agent needs a name to select the art that will be used. Currently only 4 names are supported: Brad, Ellie, Rens, and Laura. Note: This is NOT the name that users will see when they negotiate with the agent.

Specified by:

getArtName in class GeneralVH

Returns:

the name of the character model to be used. If this does not match "Brad", "Ellie", "Rens", or "Laura", one of those names will be selected as a default. Please use one of those names.