Packageorg.ffilmation.engine.interfaces
Interfacepublic interface fEngineSceneRetriever
ImplementorsfSceneFromXML, fSceneLoader

This interface defines methods that any class that is to be used to retrieve an scene XML must implement. I'm using this interface definition rather that simply loading an XML because this allows to create custom classes that generate random maps, for example.


Public Methods
 MethodDefined by
  
getBasePath():String
The scene will use this method to retrieve the basepath for this XML.
fEngineSceneRetriever
  
getXML():XML
The scene will use this method to retrieve the XML definition once when a COMPLETE event is triggered
fEngineSceneRetriever
  
start():EventDispatcher
The scene will call this when it is ready to receive an scene.
fEngineSceneRetriever
Method detail
getBasePath()method
public function getBasePath():String

The scene will use this method to retrieve the basepath for this XML. This basepath will be used to resolve paths inside this XML

Returns
String
getXML()method 
public function getXML():XML

The scene will use this method to retrieve the XML definition once when a COMPLETE event is triggered

Returns
XML
start()method 
public function start():EventDispatcher

The scene will call this when it is ready to receive an scene. Then the engine will listen for a COMPLETE event of the returned object before retrieving the final xml

Returns
EventDispatcher