View Single Post in: C# Script Utility Overview
#7
17th Oct 2021 at 5:20 PM
17th Oct 2021 at 5:20 PM
Posts: 436
Thanks: 976 in 6 Posts
Export_Import
(Serializing Objects)
Battery.Export_Import
string ToExportString<T>(this T objecttoexport)
Usage: Converts an object into a serialized string, it is used like the ToString method
Note 0: This works only with classes that have a parameterless constructor and do NOT contain cyclical references*
Note 1: The Default Serializer is not capable of converting cyclical references
Example:
Overloads:
string ToExportString<T>(this T objecttoexport, bool MarkedOnly)
//This Serializes only Fields marked with the [MarkExportable] attribute
string ToExportString<T>(this T objecttoexport, bool MarkedOnly, BindingFlags flags)
//This Serializes only Fields marked with the [MarkExportable] attribute and the given BindingFlags
string ToExportString<T>(this T objecttoexport, bool MarkedOnly, BindingFlags flags, Dictionary<Type,ICustomSerializer> CustomSerializer)
//This Serializes only Fields marked with the [MarkExportable] attribute and the given BindingFlags you can supply a dictionary that allows you to serialize arbitrary types
Parameters:
bool MarkedOnly if this is set to true it will only serialize objects decorated with the [MarkExportable] attribute, Default setting false (this will serialize fields not marked with [MarkExportable(false)]
BindingFlags flags define the Bindingflags which a field needs to have in order to be serialized (default 62), example value "BindingFlags.Static|BindingFlags.Public" will only serialize fields which are public and static
Dictionary<Type,ICustomSerializer> CustomSerializer supply custom serialization instructions
interface ICustomSerializer
Usage: This can be used in conjunction with ToExportString to serialize/deserialize cyclical references or create objects without an parameterless constructor
Example: Serializing a field of type Vector3
(Serializing Objects)
Battery.Export_Import
string ToExportString<T>(this T objecttoexport)
Usage: Converts an object into a serialized string, it is used like the ToString method
Note 0: This works only with classes that have a parameterless constructor and do NOT contain cyclical references*
Note 1: The Default Serializer is not capable of converting cyclical references
Example:
Code:
UserSettings MySettings = new UserSettings (); string serialized = MySettings.ToExportString(); //saves/serializes the Data of MySettings into the string serialized
Overloads:
string ToExportString<T>(this T objecttoexport, bool MarkedOnly)
//This Serializes only Fields marked with the [MarkExportable] attribute
string ToExportString<T>(this T objecttoexport, bool MarkedOnly, BindingFlags flags)
//This Serializes only Fields marked with the [MarkExportable] attribute and the given BindingFlags
string ToExportString<T>(this T objecttoexport, bool MarkedOnly, BindingFlags flags, Dictionary<Type,ICustomSerializer> CustomSerializer)
//This Serializes only Fields marked with the [MarkExportable] attribute and the given BindingFlags you can supply a dictionary that allows you to serialize arbitrary types
Parameters:
bool MarkedOnly if this is set to true it will only serialize objects decorated with the [MarkExportable] attribute, Default setting false (this will serialize fields not marked with [MarkExportable(false)]
BindingFlags flags define the Bindingflags which a field needs to have in order to be serialized (default 62), example value "BindingFlags.Static|BindingFlags.Public" will only serialize fields which are public and static
Dictionary<Type,ICustomSerializer> CustomSerializer supply custom serialization instructions
interface ICustomSerializer
Code:
public interface ICustomSerializer
{
void Serialize(object objecttoserialize, BindingFlags flags, int Rekursion, Export_Import.SerializationData sData);
object Deserialize(Type objectType, string source, int Rekursion, Export_Import.SerializationData sData);
}
Usage: This can be used in conjunction with ToExportString to serialize/deserialize cyclical references or create objects without an parameterless constructor
Example: Serializing a field of type Vector3
Code:
public class Vector3_Serializer : ICustomSerializer
{
public void Serialize(object objecttoserialize, BindingFlags flags, int Rekursion, Export_Import.SerializationData sData)
{
Vector3 v = ((Vector3)objecttoserialize); //cast the object to Vector3
sData.mExportString.Append(v.x+","+v.y+","+v.z); //add the important information x, y ,z to our Exportstring and seperate them with ","
}
public object Deserialize(Type objectType, string source, int Rekursion, Export_Import.SerializationData sData)
{
string[] result = source.Split(','); //get the data seperated by ","
return new Vector3(float.Parse(result[0]),float.Parse(result[1]) ,float.Parse(result[2])); //Create a new Vector with the 3 Axis values x,y,z
}
}