SpawnGenerator (Atavism Server API

java.lang.Object
- atavism.agis.objects.SpawnGenerator

All Implemented Interfaces:: MessageCallback, MessageDispatch, java.lang.Runnable

public class SpawnGenerator
extends java.lang.Object
implements MessageDispatch, java.lang.Runnable

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

protected class SpawnGenerator.CorpseDespawner

Nested Classes
Modifier and Type	Class and Description
`protected class`	`SpawnGenerator.CorpseDespawner`

Field Summary

Fields
Modifier and Type	Field and Description
`protected boolean`	`active`
`protected int`	`alternateSpawnMobTemplate`
`protected int`	`alternateState`
`protected int`	`corpseDespawnTime`
`protected int`	`endHour`
`protected ObjectFactory`	`factory`
`protected OID`	`instanceOid`
`protected Point`	`loc`
`protected java.lang.String`	`name`
`protected int`	`numSpawns`
`protected Quaternion`	`orient`
`protected int`	`respawnTime`
`protected int`	`respawnTimeMax`
`protected SpawnData`	`spawnData`
`protected int`	`spawnID`
`protected int`	`spawnRadius`
`protected java.util.Set<ObjectStub>`	`spawns`
`protected int`	`standardSpawnMobTemplate`
`protected int`	`startHour`

Fields inherited from interface atavism.msgsys.MessageCallback
NO_FLAGS, RESPONSE_EXPECTED

Constructor Summary

Constructors
Constructor and Description

SpawnGenerator(SpawnData data)

Constructors
Constructor and Description
`SpawnGenerator(SpawnData data)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`activate()`
`protected void`	`addDeathWatch(OID oid)`
`static void`	`cleanupInstance(OID instanceOid)` Deactivates all SpawnGenerators belonging to the instanceOid specified.
`void`	`deactivate(boolean cleanup)`
`void`	`deactivateNotInCombat()`
`static void`	`disableSpawnsInArea(OID instanceOid, Point loc, float radius)` Goes through all SpawnGenerators in the instanceOid and deactivates any that are within the disabled area.
`int`	`getCorpseDespawnTime()`
`OID`	`getInstanceOid()`
`Point`	`getLoc()`
`java.lang.String`	`getName()`
`int`	`getNumSpawns()`
`ObjectFactory`	`getObjectFactory()`
`Quaternion`	`getOrientation()`
`int`	`getRespawnTime()`
`int`	`getRespawnTimeMax()`
`SpawnData`	`getSpawnData()`
`int`	`getSpawnId()`
`int`	`getSpawnRadius()`
`void`	`handleMessage(Message msg, int flags)` Handle message.
`void`	`initialize(SpawnData data)`
`static boolean`	`isSpawnInDisabledArea(OID instanceOid, Point loc)` Checks if the spawn generator is located within a disabled area.
`protected void`	`removeDeathWatch(OID oid)`
`static void`	`removeSpawnGenerator(OID instanceOid, java.lang.String spawnName)` Deactivates and removes the SpawnGenerator based on the spawnName and instanceOid given.
`static void`	`removeSpawnGeneratorByID(OID instanceOid, int spawnID)` Deactivates and removes the SpawnGenerator based on the spawnID and instanceOid given.
`static void`	`respawnMatchingMobs(OID instanceOid, int mobID)` Goes through all SpawnGenerators in the instanceOid and respawns all mobs that match the mob template ID.
`void`	`run()`
`static void`	`serverTimeUpdate(int hour, int minute)` Goes through all spawn generators and activates/deactivates them based on their active times.
`void`	`setCorpseDespawnTime(int time)`
`void`	`setInstanceOid(OID oid)`
`void`	`setLoc(Point p)`
`void`	`setName(java.lang.String name)`
`void`	`setNumSpawns(int num)`
`void`	`setObjectFactory(ObjectFactory factory)`
`void`	`setOrientation(Quaternion o)`
`void`	`setRespawnTime(int milliseconds)`
`void`	`setRespawnTimeMax(int milliseconds)`
`void`	`setSpawnData(SpawnData spawnData)`
`void`	`setSpawnID(int spawnID)`
`void`	`setSpawnRadius(int radius)`
`void`	`spawnMobs()`
`protected void`	`spawnObject()`
`protected void`	`spawnObject(int millis)`
`java.lang.String`	`ToString()`
`protected void`	`updateObjectProperties(ObjectStub obj)` Sets certain properties for the object that was just spawned.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

spawnID
```
protected int spawnID
```

instanceOid
```
protected OID instanceOid
```

name
```
protected java.lang.String name
```

loc
```
protected Point loc
```

orient
```
protected Quaternion orient
```

spawnRadius
```
protected int spawnRadius
```

respawnTime
```
protected int respawnTime
```

respawnTimeMax
```
protected int respawnTimeMax
```

numSpawns
```
protected int numSpawns
```

corpseDespawnTime
```
protected int corpseDespawnTime
```

startHour
```
protected int startHour
```

endHour
```
protected int endHour
```

alternateSpawnMobTemplate

protected int alternateSpawnMobTemplate

standardSpawnMobTemplate
```
protected int standardSpawnMobTemplate
```

alternateState
```
protected int alternateState
```

active
```
protected boolean active
```

spawnData
```
protected SpawnData spawnData
```

factory
```
protected ObjectFactory factory
```

spawns

protected java.util.Set<ObjectStub> spawns

Constructor Detail
- SpawnGenerator
```
public SpawnGenerator(SpawnData data)
```

Method Detail

initialize

public void initialize(SpawnData data)

ToString
```
public java.lang.String ToString()
```

activate
```
public void activate()
```

spawnMobs
```
public void spawnMobs()
```

deactivate

public void deactivate(boolean cleanup)

deactivateNotInCombat
```
public void deactivateNotInCombat()
```

handleMessage
```
public void handleMessage(Message msg,
                          int flags)
```
Description copied from interface: MessageCallback

Handle message.

Specified by:

handleMessage in interface MessageCallback

Parameters:

msg - Message sent from other agent.

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

spawnObject
```
protected void spawnObject()
```

updateObjectProperties
```
protected void updateObjectProperties(ObjectStub obj)
```
Sets certain properties for the object that was just spawned.

Parameters:

obj -

spawnObject

protected void spawnObject(int millis)

run
```
public void run()
```
Specified by:

run in interface java.lang.Runnable

addDeathWatch

protected void addDeathWatch(OID oid)

removeDeathWatch

protected void removeDeathWatch(OID oid)

getSpawnId
```
public int getSpawnId()
```

setSpawnID
```
public void setSpawnID(int spawnID)
```

getInstanceOid
```
public OID getInstanceOid()
```

setInstanceOid
```
public void setInstanceOid(OID oid)
```

setName

public void setName(java.lang.String name)

getName
```
public java.lang.String getName()
```

setLoc
```
public void setLoc(Point p)
```

getLoc
```
public Point getLoc()
```

setOrientation

public void setOrientation(Quaternion o)

getOrientation
```
public Quaternion getOrientation()
```

getSpawnRadius
```
public int getSpawnRadius()
```

setSpawnRadius

public void setSpawnRadius(int radius)

getRespawnTime
```
public int getRespawnTime()
```

setRespawnTime

public void setRespawnTime(int milliseconds)

getRespawnTimeMax
```
public int getRespawnTimeMax()
```

setRespawnTimeMax

public void setRespawnTimeMax(int milliseconds)

getNumSpawns
```
public int getNumSpawns()
```

setNumSpawns
```
public void setNumSpawns(int num)
```

getCorpseDespawnTime
```
public int getCorpseDespawnTime()
```

setCorpseDespawnTime

public void setCorpseDespawnTime(int time)

getObjectFactory

public ObjectFactory getObjectFactory()

setObjectFactory

public void setObjectFactory(ObjectFactory factory)

getSpawnData
```
public SpawnData getSpawnData()
```

setSpawnData

public void setSpawnData(SpawnData spawnData)

cleanupInstance
```
public static void cleanupInstance(OID instanceOid)
```
Deactivates all SpawnGenerators belonging to the instanceOid specified.

Parameters:

instanceOid -

removeSpawnGenerator
```
public static void removeSpawnGenerator(OID instanceOid,
                                        java.lang.String spawnName)
```
Deactivates and removes the SpawnGenerator based on the spawnName and instanceOid given.

Parameters:

instanceOid -

spawnName -

removeSpawnGeneratorByID
```
public static void removeSpawnGeneratorByID(OID instanceOid,
                                            int spawnID)
```
Deactivates and removes the SpawnGenerator based on the spawnID and instanceOid given.

Parameters:

instanceOid -

spawnID -

respawnMatchingMobs
```
public static void respawnMatchingMobs(OID instanceOid,
                                       int mobID)
```
Goes through all SpawnGenerators in the instanceOid and respawns all mobs that match the mob template ID.

Parameters:

instanceOid -

mobID -

serverTimeUpdate
```
public static void serverTimeUpdate(int hour,
                                    int minute)
```
Goes through all spawn generators and activates/deactivates them based on their active times.

Parameters:

hour -

minute -

disableSpawnsInArea

public static void disableSpawnsInArea(OID instanceOid,
                                       Point loc,
                                       float radius)

Goes through all SpawnGenerators in the instanceOid and deactivates any that are within the disabled area.

Parameters:: instanceOid -; loc -; radius -

isSpawnInDisabledArea

public static boolean isSpawnInDisabledArea(OID instanceOid,
                                            Point loc)

Checks if the spawn generator is located within a disabled area.

Parameters:: instanceOid -; loc -
Returns:

Class SpawnGenerator

Nested Class Summary

Field Summary

Fields inherited from interface atavism.msgsys.MessageCallback

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

spawnID

instanceOid

name

loc

orient

spawnRadius

respawnTime

respawnTimeMax

numSpawns

corpseDespawnTime

startHour

endHour

alternateSpawnMobTemplate

standardSpawnMobTemplate

alternateState

active

spawnData

factory

spawns

Constructor Detail

SpawnGenerator

Method Detail

initialize

ToString

activate

spawnMobs

deactivate

deactivateNotInCombat

handleMessage

spawnObject

updateObjectProperties

spawnObject

run

addDeathWatch

removeDeathWatch

getSpawnId

setSpawnID

getInstanceOid

setInstanceOid

setName

getName

setLoc

getLoc

setOrientation

getOrientation

getSpawnRadius

setSpawnRadius

getRespawnTime

setRespawnTime

getRespawnTimeMax

setRespawnTimeMax

getNumSpawns

setNumSpawns

getCorpseDespawnTime

setCorpseDespawnTime

getObjectFactory

setObjectFactory

getSpawnData

setSpawnData

cleanupInstance

removeSpawnGenerator

removeSpawnGeneratorByID

respawnMatchingMobs

serverTimeUpdate

disableSpawnsInArea

isSpawnInDisabledArea