atavism.server.engine

Interface WorldLoaderOverride

All Known Implementing Classes:

DefaultWorldLoaderOverride

public interface WorldLoaderOverride

Override objects created during world file loading. Implement this interface to modify or override objects created from world files and world collections. Each method is called prior to creating an object. If the method returns false, the object is not created. The method may modify the object's initialization data (via Template, LightData, SpawnData, etc).

Register world loader override classes with InstancePlugin.registerWorldLoaderOverrideClass(String,Class). Set the instance's loader override by setting property InstanceClient.TEMPL_LOADER_OVERRIDE_NAME to the loader override's registered name. A new instance of the class will be created prior to loading the instance's world file.

Method Summary

Modifier and Type	Method and Description
boolean	adjustObjectTemplate(java.lang.String worldCollectionName, java.lang.String objectName, Template template) Modify or override object templates.

Method Detail

adjustObjectTemplate

boolean adjustObjectTemplate(java.lang.String worldCollectionName,
                             java.lang.String objectName,
                             Template template)

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>".

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.