atavism.agis.objects
Class InteractiveObject

java.lang.Object
  atavism.agis.objects.InteractiveObject

All Implemented Interfaces:

MessageCallback, java.io.Serializable, java.lang.Runnable

public class InteractiveObject
extends java.lang.Object
implements java.io.Serializable, MessageCallback, java.lang.Runnable

An Interactive Object is an object players can interact with. The Object can have different interaction types, along with requirements to be able to interact with it.

Author:

Andrew Harrison

See Also:

Serialized Form

Nested Class Summary

class	InteractiveObject.InteractiveObjectEntity Sub-class needed for the interpolated world node so a perceiver can be created.
class	InteractiveObject.InteractTask A Runnable class that adds an object to the claim when it is run.

Field Summary

Fields inherited from interface atavism.msgsys.MessageCallback

NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

InteractiveObject()

InteractiveObject(int id, AOVector loc, OID instanceOID)

Method Summary

void	activate() Subscribes the instance to receive certain relevant messages that are sent to the world object created by this instance.
void	addPlayer(OID playerOid) Add a player to the update list for this ResourceNode.
void	despawnResource()
boolean	getActive()
java.lang.String	getCoordEffect()
java.lang.String	getGameObject()
float	getHarvestTimeReq()
int	getID()
OID	getInstanceOID()
java.lang.String	getInteractionData1()
java.lang.String	getInteractionData2()
java.lang.String	getInteractionData3()
int	getInteractionID()
java.lang.String	getInteractionType()
AOVector	getLoc()
java.lang.String	getName()
OID	getObjectOID()
java.util.HashMap<java.lang.String,java.io.Serializable>	getProps()
int	getQuestIDReq()
int	getRespawnTime()
void	handleMessage(Message msg, int flags) Deals with the messages the instance has picked up.
void	removePlayer(OID playerOid) Removes a player from the ResourceNode.
void	run()
void	setActive(boolean active)
void	setCoordEffect(java.lang.String coordinatedEffect)
void	setGameObject(java.lang.String gameObject)
void	setHarvestTimeReq(float harvestTimeReq)
void	setID(int id)
void	setInstanceOID(OID instanceOID)
void	setInteractionData1(java.lang.String interactionData1)
void	setInteractionData2(java.lang.String interactionData2)
void	setInteractionData3(java.lang.String interactionData3)
void	setInteractionID(int interactionID)
void	setInteractionType(java.lang.String interactionType)
void	setLoc(AOVector loc)
void	setName(java.lang.String name)
void	setObjectOID(OID objectOID)
void	setProps(java.util.HashMap<java.lang.String,java.io.Serializable> props)
void	setQuestIDReq(int questIDReq)
void	setRespawnTime(int respawnTime)
void	spawn() Spawn a world object for the claim.
void	spawn(OID instanceOID) An external call to spawn a world object for the claim.
void	tryUseObject(OID playerOid, java.lang.String state)

Methods inherited from class java.lang.Object

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

Constructor Detail

InteractiveObject

public InteractiveObject()

InteractiveObject

public InteractiveObject(int id,
                         AOVector loc,
                         OID instanceOID)

Method Detail

activate

public void activate()

Subscribes the instance to receive certain relevant messages that are sent to the world object created by this instance.

handleMessage

public void handleMessage(Message msg,
                          int flags)

Deals with the messages the instance has picked up.

Specified by:

handleMessage in interface MessageCallback

Parameters:

msg - Message sent from other agent.

flags - Bitwise OR of MessageCallback.NO_FLAGS, MessageCallback.RESPONSE_EXPECTED.

run

public void run()

Specified by:

run in interface java.lang.Runnable

spawn

public void spawn(OID instanceOID)

An external call to spawn a world object for the claim.

Parameters:

instanceOID -

spawn

public void spawn()

Spawn a world object for the claim.

addPlayer

public void addPlayer(OID playerOid)

Add a player to the update list for this ResourceNode. The player will receive data about the node and any updates that occur.

Parameters:

playerOID -

removePlayer

public void removePlayer(OID playerOid)

Removes a player from the ResourceNode. They will no longer receive updates.

Parameters:

playerOID -

removeLastID -

tryUseObject

public void tryUseObject(OID playerOid,
                         java.lang.String state)

despawnResource

public void despawnResource()

getID

public int getID()

setID

public void setID(int id)

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getGameObject

public java.lang.String getGameObject()

setGameObject

public void setGameObject(java.lang.String gameObject)

getCoordEffect

public java.lang.String getCoordEffect()

setCoordEffect

public void setCoordEffect(java.lang.String coordinatedEffect)

getLoc

public AOVector getLoc()

setLoc

public void setLoc(AOVector loc)

getProps

public java.util.HashMap<java.lang.String,java.io.Serializable> getProps()

setProps

public void setProps(java.util.HashMap<java.lang.String,java.io.Serializable> props)

getInstanceOID

public OID getInstanceOID()

setInstanceOID

public void setInstanceOID(OID instanceOID)

getObjectOID

public OID getObjectOID()

setObjectOID

public void setObjectOID(OID objectOID)

getQuestIDReq

public int getQuestIDReq()

setQuestIDReq

public void setQuestIDReq(int questIDReq)

getInteractionType

public java.lang.String getInteractionType()

setInteractionType

public void setInteractionType(java.lang.String interactionType)

getInteractionID

public int getInteractionID()

setInteractionID

public void setInteractionID(int interactionID)

getInteractionData1

public java.lang.String getInteractionData1()

setInteractionData1

public void setInteractionData1(java.lang.String interactionData1)

getInteractionData2

public java.lang.String getInteractionData2()

setInteractionData2

public void setInteractionData2(java.lang.String interactionData2)

getInteractionData3

public java.lang.String getInteractionData3()

setInteractionData3

public void setInteractionData3(java.lang.String interactionData3)

getActive

public boolean getActive()

setActive

public void setActive(boolean active)

getRespawnTime

public int getRespawnTime()

setRespawnTime

public void setRespawnTime(int respawnTime)

getHarvestTimeReq

public float getHarvestTimeReq()

setHarvestTimeReq

public void setHarvestTimeReq(float harvestTimeReq)