atavism.agis.objects
Class ResourceNode

java.lang.Object
  atavism.agis.objects.ResourceNode

All Implemented Interfaces:

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

Direct Known Subclasses:

FishingResourceNode

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

A ResourceNode is an object players can gather items from. The ResourceNode randomly generates its items upon spawn from the items it has been given and allows the player to gather them if they meet the requirements.

Author:

Andrew Harrison

See Also:

Serialized Form

Nested Class Summary

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

Field Summary

Fields inherited from interface atavism.msgsys.MessageCallback

NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

ResourceNode()

ResourceNode(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	activateAsChildOfGroup()
void	addPlayer(OID playerOid) Add a player to the update list for this ResourceNode.
void	AddResourceDrop(int item, int min, int max, float chance)
void	despawnResource()
void	gatherAllItems(OID playerOid)
void	gatherItem(OID playerOid, int itemID)
boolean	getActive()
java.lang.String	getCoordEffect()
boolean	getEquippedReq()
java.lang.String	getGameObject()
int	getHarvestCount()
float	getHarvestTimeReq()
int	getID()
OID	getInstanceOID()
AOVector	getLoc()
java.lang.String	getName()
OID	getObjectOID()
java.util.HashMap<java.lang.String,java.io.Serializable>	getProps()
int	getRespawnTime()
int	getSkill()
int	getSkillLevelMax()
int	getSkillLevelReq()
java.lang.String	getWeaponReq()
void	handleMessage(Message msg, int flags) Deals with the messages the instance has picked up.
void	printType()
void	removePlayer(OID playerOid) Removes a player from the ResourceNode.
void	run()
void	setActive(boolean active)
void	setCoordEffect(java.lang.String coordinatedEffect)
void	setEquippedReq(boolean equippedReq)
void	setGameObject(java.lang.String gameObject)
void	setHarvestCount(int harvestCount)
void	setHarvestTimeReq(float harvestTimeReq)
void	setID(int id)
void	setInstanceOID(OID instanceOID)
void	setLoc(AOVector loc)
void	setMobAsSkinnable(OID mobOid)
void	setName(java.lang.String name)
void	setObjectOID(OID objectOID)
void	setProps(java.util.HashMap<java.lang.String,java.io.Serializable> props)
void	setRespawnTime(int respawnTime)
void	setSkill(int skill)
void	setSkillLevelMax(int skillLevelMax)
void	setSkillLevelReq(int skillLevelReq)
void	setWeaponReq(java.lang.String weaponReq)
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	tryHarvestResources(OID playerOid)

Methods inherited from class java.lang.Object

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

Constructor Detail

ResourceNode

public ResourceNode()

ResourceNode

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

Method Detail

AddResourceDrop

public void AddResourceDrop(int item,
                            int min,
                            int max,
                            float chance)

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.

activateAsChildOfGroup

public void activateAsChildOfGroup()

setMobAsSkinnable

public void setMobAsSkinnable(OID mobOid)

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 -

tryHarvestResources

public void tryHarvestResources(OID playerOid)

gatherItem

public void gatherItem(OID playerOid,
                       int itemID)

gatherAllItems

public void gatherAllItems(OID playerOid)

despawnResource

public void despawnResource()

printType

public void printType()

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)

getEquippedReq

public boolean getEquippedReq()

setEquippedReq

public void setEquippedReq(boolean equippedReq)

getSkill

public int getSkill()

setSkill

public void setSkill(int skill)

getSkillLevelReq

public int getSkillLevelReq()

setSkillLevelReq

public void setSkillLevelReq(int skillLevelReq)

getSkillLevelMax

public int getSkillLevelMax()

setSkillLevelMax

public void setSkillLevelMax(int skillLevelMax)

getWeaponReq

public java.lang.String getWeaponReq()

setWeaponReq

public void setWeaponReq(java.lang.String weaponReq)

getActive

public boolean getActive()

setActive

public void setActive(boolean active)

getRespawnTime

public int getRespawnTime()

setRespawnTime

public void setRespawnTime(int respawnTime)

getHarvestCount

public int getHarvestCount()

setHarvestCount

public void setHarvestCount(int harvestCount)

getHarvestTimeReq

public float getHarvestTimeReq()

setHarvestTimeReq

public void setHarvestTimeReq(float harvestTimeReq)