PackagePBLabs.Engine.Serialization
Classpublic class Serializer

Singleton class for serializing and deserializing objects. This class implements a default serialization behavior based on the format described in the XMLFormat reference. This default behavior can be replaced on a class by class basis by implementing the ISerializable interface.

See also

ISerializable

Public Properties
 PropertyDefined by
  Instance : Serializer
[static][read-only] Gets the singleton instance of the serializer class.
Serializer
Public Methods
 MethodDefined by
  
Serializer()
Serializer
  
_RemoveResource(filename:String):void
Serializer
  
ClearCurrentEntity():void
Clear the entity relative to which current serialization work is happening.
Serializer
  
Deserialize(object:*, xml:XML, typeHint:String = null):*
Deserializes an object from an xml description.
Serializer
  
ReportMissingReferences():void
Not all references are resolved immediately.
Serializer
  
ResolveReferences():void
Serializer
  
Serialize(object:*, xml:XML):void
Serializes an object to XML.
Serializer
  
SetCurrentEntity(e:IEntity):void
Set the entity relative to which current serialization work is happening.
Serializer
Property detail
Instanceproperty
Instance:Serializer  [read-only]

Gets the singleton instance of the serializer class.

Implementation
    public static function get Instance():Serializer
Constructor detail
Serializer()constructor
public function Serializer()
Method detail
_RemoveResource()method
public function _RemoveResource(filename:String):voidParameters
filename:String
ClearCurrentEntity()method 
public function ClearCurrentEntity():void

Clear the entity relative to which current serialization work is happening. Mostly for internal use.

Deserialize()method 
public function Deserialize(object:*, xml:XML, typeHint:String = null):*

Deserializes an object from an xml description.

Parameters
object:* — The object on which the xml description will be applied.
 
xml:XML — The xml to deserialize from.
 
typeHint:String (default = null) — For an array, dictionary, or dynamic class, a type hint can be specified as to what its children should be. Optional.

Returns
* — A reference to the deserialized object. This is always the same as the object parameter, with the exception of types that are passed by value. Code that calls this method should always use the return value rather than the passed in value for this reason.
ReportMissingReferences()method 
public function ReportMissingReferences():void

Not all references are resolved immediately. In order to minimize spam, we only report "dangling references" at certain times. This method triggers such a report.

ResolveReferences()method 
public function ResolveReferences():void
Serialize()method 
public function Serialize(object:*, xml:XML):void

Serializes an object to XML. This is currently not implemented.

Parameters
object:* — The object to serialize. If this object implements ISerializable, its Serialize method will be called to do the serialization, otherwise the default behavior will be used.
 
xml:XML

See also

ISerializable
SetCurrentEntity()method 
public function SetCurrentEntity(e:IEntity):void

Set the entity relative to which current serialization work is happening. Mostly for internal use.

Parameters
e:IEntity