Version 1.5APIs subject to change!

multiverse.server.objects
Class Instance

java.lang.Object
  extended by multiverse.server.objects.NamedPropertyClass
      extended by multiverse.server.objects.Entity
          extended by multiverse.server.objects.Instance
All Implemented Interfaces:
java.io.Serializable

public class Instance
extends Entity

See Also:
Serialized Form

Field Summary
 
Fields inherited from class multiverse.server.objects.Entity
log, staticLock, subObjectNamespacesInt, transientPropertyKeys, type
 
Fields inherited from class multiverse.server.objects.NamedPropertyClass
lock
 
Constructor Summary
Instance()
           
Instance(long oid)
           
 
Method Summary
 void addRegion(Region region)
           
 void addRegionConfig(java.lang.String region)
           
 void addSpawnData(SpawnData spawnData)
           
 void changePlayerPopulation(int delta)
           
static Instance current()
           
static long currentOid()
           
 Color getGlobalAmbientLight()
           
 LightData getGlobalDirectionalLight()
           
 Fog getGlobalFog()
           
 Region getGlobalRegion()
           
 java.lang.String getGlobalSkybox()
           
 java.lang.String getInitScriptFileName()
           
 java.lang.String getLoadScriptFileName()
           
 Marker getMarker(java.lang.String name)
           
 java.lang.String getName()
          Returns the name of this entity.
 OceanData getOceanData()
           
 PathInfo getPathInfo()
           
 int getPlayerPopulation()
           
 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()
           
 java.lang.String getTemplateName()
           
 TerrainConfig getTerrainConfig()
           
 java.lang.String getWorldFileName()
           
 boolean loadWorldFile()
           
 boolean runInitScript()
           
 boolean runLoadScript()
           
 java.util.Collection runMarkerSearch(SearchClause search, SearchSelection selection)
           
 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 setInitScriptFileName(java.lang.String fileName)
           
 void setLoadScriptFileName(java.lang.String fileName)
           
 void setMarker(java.lang.String name, Marker marker)
           
 void setName(java.lang.String name)
          Sets the name for this entity.
 void setOceanData(OceanData od)
           
 void setTemplateName(java.lang.String templateName)
           
 void setTerrainConfig(TerrainConfig terrainConfig)
           
 void setWorldFileName(java.lang.String fileName)
           
 
Methods inherited from class multiverse.server.objects.Entity
equals, equals, getAllEntitiesByNamespace, getEntityByNamespace, getEntityCount, getLock, getNamespace, getOid, getPersistenceFlag, getProperty, getSubObjectNamespaces, getSubObjectNamespacesInt, getTransientDataRef, getType, hashCode, isDeleted, registerEntityByNamespace, registerTransientPropertyKey, removeEntityByNamespace, removeEntityByNamespace, setDeleted, setNamespace, setOid, setPersistenceFlag, setProperty, setSubObjectNamespaces, setSubObjectNamespacesInt, setType, toBytes, toString, unregisterTransientPropertyKey
 
Methods inherited from class multiverse.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
 

Constructor Detail

Instance

public Instance()

Instance

public Instance(long 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)

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)

loadWorldFile

public boolean loadWorldFile()

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()

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()

getMarker

public Marker getMarker(java.lang.String name)

setMarker

public void setMarker(java.lang.String name,
                      Marker marker)

addSpawnData

public void addSpawnData(SpawnData spawnData)

getSpawnData

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

getPathInfo

public PathInfo getPathInfo()

changePlayerPopulation

public void changePlayerPopulation(int delta)

getPlayerPopulation

public int getPlayerPopulation()

current

public static Instance current()

currentOid

public static long currentOid()

runMarkerSearch

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

runRegionSearch

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


Copyright © 2008 The Multiverse Network, Inc.