atavism.server.objects
Class Instance

java.lang.Object
  atavism.server.objects.NamedPropertyClass
      atavism.server.objects.Entity
          atavism.server.objects.Instance

All Implemented Interfaces:

java.io.Serializable

public class Instance
extends Entity

See Also:

Serialized Form

Field Summary

static int	STATE_AVAILABLE
static int	STATE_DELETE
static int	STATE_GENERATE
static int	STATE_INIT
static int	STATE_LOAD
static int	STATE_UNLOAD

Fields inherited from class atavism.server.objects.Entity

log, staticLock, subObjectNamespacesInt, transientPropertyKeys, type

Fields inherited from class atavism.server.objects.NamedPropertyClass

lock

Constructor Summary

Instance()

Instance(OID oid)

Method Summary

void	addRegion(Region region)
void	addRegionConfig(java.lang.String region)
void	addSpawnData(SpawnData spawnData)
int	changePlayerPopulation(int delta)
static Instance	current()
static OID	currentOid()
Color	getGlobalAmbientLight()
LightData	getGlobalDirectionalLight()
Fog	getGlobalFog()
Region	getGlobalRegion()
java.lang.String	getGlobalSkybox()
OID	getGroupOid()
int	getGuildOid()
java.lang.String	getInitScriptFileName()
java.lang.String	getLoadScriptFileName()
java.lang.String	getName() Returns the name of this entity.
OceanData	getOceanData()
PathInfo	getPathInfo()
OID	getPlayerOid()
int	getPlayerPopulation()
int	getPopulationLimit()
Region	getRegion(java.lang.String regionName)
java.util.List<java.lang.String>	getRegionConfig()
java.util.List<Region>	getRegionList()
RoadRegionConfig	getRoadConfig()
java.util.List<SpawnData>	getSpawnData()
int	getState()
int	getTemplateID()
java.lang.String	getTemplateName()
TerrainConfig	getTerrainConfig()
WorldCollectionLoaderContext	getWorldCollectionLoaderContext()
java.lang.String	getWorldFileName()
WorldLoaderOverride	getWorldLoaderOverride()
java.lang.String	getWorldLoaderOverrideName()
boolean	loadWorldCollections() Load additional world collections that may not have been mentioned in the world file.
boolean	loadWorldData() Sets up the world settings such as skybox and fog based on the template values.
boolean	loadWorldFile()
boolean	runInitScript()
boolean	runLoadScript()
java.util.Collection	runRegionSearch(SearchClause search, SearchSelection selection)
void	setGlobalAmbientLight(Color lightColor)
void	setGlobalDirectionalLight(LightData lightData)
void	setGlobalFog(Fog fog)
void	setGlobalSkybox(java.lang.String skybox)
void	setGroupOid(OID groupOid)
void	setGuildOid(int guildOid)
void	setInitScriptFileName(java.lang.String fileName)
void	setLoadScriptFileName(java.lang.String fileName)
void	setName(java.lang.String name) Sets the name for this entity.
void	setOceanData(OceanData od)
void	setPlayerOid(OID playerOid)
void	setPopulationLimit(int populationLimit)
void	setState(int state)
void	setTemplateID(int templateID)
void	setTemplateName(java.lang.String templateName)
void	setTerrainConfig(TerrainConfig terrainConfig)
protected void	setupGlobalRegion()
void	setWorldCollectionLoaderContext(WorldCollectionLoaderContext context)
void	setWorldFileName(java.lang.String fileName)
void	setWorldLoaderOverride(WorldLoaderOverride loaderOverride)
void	setWorldLoaderOverrideName(java.lang.String loaderName)

Methods inherited from class atavism.server.objects.Entity

addSubObjectNamespace, equals, equals, getLock, getNamespace, getOid, getPersistenceFlag, getProperty, getSubObjectNamespaces, getSubObjectNamespacesInt, getTransientDataRef, getType, hashCode, hasSubObjectNamespace, isDeleted, registerTransientPropertyKey, removeProperty, removeSubObjectNamespace, setDeleted, setNamespace, setOid, setPersistenceFlag, setProperty, setSubObjectNamespaces, setSubObjectNamespacesInt, setType, toBytes, toString, unregisterTransientPropertyKey

Methods inherited from class atavism.server.objects.NamedPropertyClass

getBooleanProperty, getIntProperty, getPropertyMap, getPropertyMapRef, getStringProperty, lock, modifyIntProperty, setPropertyMap, setupTransient, unlock

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STATE_INIT

public static final int STATE_INIT

See Also:

Constant Field Values

STATE_GENERATE

public static final int STATE_GENERATE

See Also:

Constant Field Values

STATE_LOAD

public static final int STATE_LOAD

See Also:

Constant Field Values

STATE_AVAILABLE

public static final int STATE_AVAILABLE

See Also:

Constant Field Values

STATE_UNLOAD

public static final int STATE_UNLOAD

See Also:

Constant Field Values

STATE_DELETE

public static final int STATE_DELETE

See Also:

Constant Field Values

Constructor Detail

Instance

public Instance()

Instance

public Instance(OID oid)

Method Detail

getName

public java.lang.String getName()

Description copied from class: NamedPropertyClass

Returns the name of this entity.

Overrides:

getName in class NamedPropertyClass

Returns:

name for this entity.

setName

public void setName(java.lang.String name)

Description copied from class: NamedPropertyClass

Sets the name for this entity.

Overrides:

setName in class NamedPropertyClass

Parameters:

name - name for this entity.

getTemplateName

public java.lang.String getTemplateName()

setTemplateName

public void setTemplateName(java.lang.String templateName)

getTemplateID

public int getTemplateID()

setTemplateID

public void setTemplateID(int templateID)

getWorldFileName

public java.lang.String getWorldFileName()

setWorldFileName

public void setWorldFileName(java.lang.String fileName)

getInitScriptFileName

public java.lang.String getInitScriptFileName()

setInitScriptFileName

public void setInitScriptFileName(java.lang.String fileName)

getLoadScriptFileName

public java.lang.String getLoadScriptFileName()

setLoadScriptFileName

public void setLoadScriptFileName(java.lang.String fileName)

getState

public int getState()

setState

public void setState(int state)

getWorldLoaderOverrideName

public java.lang.String getWorldLoaderOverrideName()

setWorldLoaderOverrideName

public void setWorldLoaderOverrideName(java.lang.String loaderName)

getWorldLoaderOverride

public WorldLoaderOverride getWorldLoaderOverride()

setWorldLoaderOverride

public void setWorldLoaderOverride(WorldLoaderOverride loaderOverride)

loadWorldData

public boolean loadWorldData()

Sets up the world settings such as skybox and fog based on the template values.

Returns:

setupGlobalRegion

protected void setupGlobalRegion()

loadWorldFile

public boolean loadWorldFile()

loadWorldCollections

public boolean loadWorldCollections()

Load additional world collections that may not have been mentioned in the world file.

Parameters:

worldCollections -

Returns:

true if all of the loads succeeded.

runInitScript

public boolean runInitScript()

runLoadScript

public boolean runLoadScript()

getGlobalSkybox

public java.lang.String getGlobalSkybox()

setGlobalSkybox

public void setGlobalSkybox(java.lang.String skybox)

getGlobalFog

public Fog getGlobalFog()

setGlobalFog

public void setGlobalFog(Fog fog)

getGlobalAmbientLight

public Color getGlobalAmbientLight()

setGlobalAmbientLight

public void setGlobalAmbientLight(Color lightColor)

getGlobalDirectionalLight

public LightData getGlobalDirectionalLight()

setGlobalDirectionalLight

public void setGlobalDirectionalLight(LightData lightData)

getOceanData

public OceanData getOceanData()

setOceanData

public void setOceanData(OceanData od)

getTerrainConfig

public TerrainConfig getTerrainConfig()

setTerrainConfig

public void setTerrainConfig(TerrainConfig terrainConfig)

getGlobalRegion

public Region getGlobalRegion()

getRoadConfig

public RoadRegionConfig getRoadConfig()

getPopulationLimit

public int getPopulationLimit()

setPopulationLimit

public void setPopulationLimit(int populationLimit)

getGroupOid

public OID getGroupOid()

setGroupOid

public void setGroupOid(OID groupOid)

getPlayerOid

public OID getPlayerOid()

setPlayerOid

public void setPlayerOid(OID playerOid)

getGuildOid

public int getGuildOid()

setGuildOid

public void setGuildOid(int guildOid)

addRegion

public void addRegion(Region region)

getRegion

public Region getRegion(java.lang.String regionName)

getRegionList

public java.util.List<Region> getRegionList()

addRegionConfig

public void addRegionConfig(java.lang.String region)

getRegionConfig

public java.util.List<java.lang.String> getRegionConfig()

addSpawnData

public void addSpawnData(SpawnData spawnData)

getSpawnData

public java.util.List<SpawnData> getSpawnData()

setWorldCollectionLoaderContext

public void setWorldCollectionLoaderContext(WorldCollectionLoaderContext context)

getWorldCollectionLoaderContext

public WorldCollectionLoaderContext getWorldCollectionLoaderContext()

getPathInfo

public PathInfo getPathInfo()

changePlayerPopulation

public int changePlayerPopulation(int delta)

getPlayerPopulation

public int getPlayerPopulation()

current

public static Instance current()

currentOid

public static OID currentOid()

runRegionSearch

public java.util.Collection runRegionSearch(SearchClause search,
                                            SearchSelection selection)