Atavism Version 2018.1AGIS API

atavism.server.engine
Class DefaultWorldLoaderOverride

java.lang.Object
  extended by atavism.server.engine.DefaultWorldLoaderOverride
All Implemented Interfaces:
WorldLoaderOverride

public class DefaultWorldLoaderOverride
extends java.lang.Object
implements WorldLoaderOverride

Return true for all loader override methods.


Constructor Summary
DefaultWorldLoaderOverride()
           
 
Method Summary
 boolean adjustLightData(java.lang.String worldCollectionName, java.lang.String objectName, LightData lightData)
          Modify or override point lights.
 boolean adjustObjectTemplate(java.lang.String worldCollectionName, java.lang.String objectName, Template template)
          Modify or override object templates.
 boolean adjustRegion(java.lang.String worldCollectionName, java.lang.String objectName, Region region)
          Modify or override regions.
 boolean adjustRegionConfig(java.lang.String worldCollectionName, java.lang.String objectName, Region region, RegionConfig regionConfig)
          Modify or override region configuration.
 boolean adjustSpawnData(java.lang.String worldCollectionName, java.lang.String objectName, SpawnData spawnData)
          Modify or override spawn generator.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultWorldLoaderOverride

public DefaultWorldLoaderOverride()
Method Detail

adjustLightData

public boolean adjustLightData(java.lang.String worldCollectionName,
                               java.lang.String objectName,
                               LightData lightData)
Description copied from interface: WorldLoaderOverride
Modify or override point lights.

Specified by:
adjustLightData in interface WorldLoaderOverride
Parameters:
worldCollectionName - World collection file name.
objectName - Point light name.
lightData - Light data.
Returns:
True to create the object, false to skip it.

adjustObjectTemplate

public boolean adjustObjectTemplate(java.lang.String worldCollectionName,
                                    java.lang.String objectName,
                                    Template template)
Description copied from interface: WorldLoaderOverride
Modify or override object templates. This method is called for static objects, marker-based particle effects, and marker-based sounds.

Particle effect names are constructed as "<marker-name>-<particle-effect-name>". Sound names are constructed as ""<marker-name>-<sound-file-name>".

Specified by:
adjustObjectTemplate in interface WorldLoaderOverride
Parameters:
worldCollectionName - World collection file name.
objectName - Static object name, particle effect name, or sound name.
template - Object template.
Returns:
True to create the object, false to skip it.

adjustRegion

public boolean adjustRegion(java.lang.String worldCollectionName,
                            java.lang.String objectName,
                            Region region)
Description copied from interface: WorldLoaderOverride
Modify or override regions. This method is called with region properties, but before adding RegionConfig.

Specified by:
adjustRegion in interface WorldLoaderOverride
Parameters:
worldCollectionName - World collection file name.
objectName - Region name.
Returns:
True to create the object, false to skip it.

adjustRegionConfig

public boolean adjustRegionConfig(java.lang.String worldCollectionName,
                                  java.lang.String objectName,
                                  Region region,
                                  RegionConfig regionConfig)
Description copied from interface: WorldLoaderOverride
Modify or override region configuration. This method is called for each RegionConfig on a Region. The following region features are included: sound, fog, directional light, ambient light.

Specified by:
adjustRegionConfig in interface WorldLoaderOverride
Parameters:
worldCollectionName - World collection file name.
objectName - Region name.
region - Region object.
regionConfig - Region configuration.
Returns:
True to create the object, false to skip it.

adjustSpawnData

public boolean adjustSpawnData(java.lang.String worldCollectionName,
                               java.lang.String objectName,
                               SpawnData spawnData)
Description copied from interface: WorldLoaderOverride
Modify or override spawn generator.

Specified by:
adjustSpawnData in interface WorldLoaderOverride
Parameters:
worldCollectionName - World collection file name.
objectName - Spawn generator name (marker name).
spawnData - Spawn generator data.
Returns:
True to create the object, false to skip it.


Copyright © 2018 Dragonsan Studios Sp. z o.o.