Inheritance diagram for BGC.Users.ProfileData:

Collaboration diagram for BGC.Users.ProfileData:

Public Member Functions
	ProfileData (string userName)

virtual void	Clear ()
	Clear all values and keys More...

void	SetInt (string key, int value)
	Set value at indicated key More...

void	SetBool (string key, bool value)
	Set value at indicated key More...

void	SetString (string key, string value)
	Set value at indicated key More...

void	SetFloat (string key, float value)
	Set value at indicated key More...

void	SetDouble (string key, double value)
	Set value at indicated key More...

void	SetJsonValue (string key, JsonValue value)
	Set value at indicated key More...

void	SetJsonArray (string key, JsonArray value)
	Set value at indicated key More...

int	GetInt (string key, int defaultReturn=0)
	Get value associated with indicated key More...

bool	GetBool (string key, bool defaultReturn=false)
	Get value associated with indicated key More...

float	GetFloat (string key, float defaultReturn=0f)
	Get value associated with indicated key More...

double	GetDouble (string key, double defaultReturn=0.0)
	Get value associated with indicated key More...

string	GetString (string key, string defaultReturn="")
	Get value associated with indicated key More...

JsonValue	GetJsonValue (string key, JsonValue defaultReturn=default(JsonValue))
	Get value associated with indicated key More...

JsonArray	GetJsonArray (string key, JsonArray defaultReturn=default(JsonArray))
	Get value associated with indicated key More...

bool	HasKey (string key)
	Get if any value is associated with indicated key More...

void	RemoveKey (string key)
	Remove any value is associated with indicated key More...

void	Serialize ()
	Save contents to file More...

bool	Deserialize ()
	Load user contents from file More...

virtual void	DeletePlayerData ()

Protected Attributes
string	PlayerFilePath
	Path of the user datafile More...

Properties
string	UserName `[get]`

abstract bool	IsDefault `[get]`
	Is this an instance of default data? More...

Private Attributes
JsonObject	userData = new JsonObject()

const int	userDataSerializationVersion = 1

Detailed Description

Definition at line 9 of file ProfileData.cs.

Constructor & Destructor Documentation

◆ ProfileData()

BGC.Users.ProfileData.ProfileData ( string userName )

inline

Definition at line 17 of file ProfileData.cs.

         {
             UserName = userName;
         }

Member Function Documentation

◆ Clear()

virtual void BGC.Users.ProfileData.Clear ( )

inlinevirtual

Clear all values and keys

Definition at line 31 of file ProfileData.cs.

References LightJson.JsonObject.Clear().

         {
             userData.Clear();
         }

Here is the call graph for this function:

◆ DeletePlayerData()

virtual void BGC.Users.ProfileData.DeletePlayerData ( )

inlinevirtual

Reimplemented in BGC.Users.DefaultData.

Definition at line 312 of file ProfileData.cs.

Referenced by BGC.Users.PlayerData.DeleteUserData().

         {
             if (File.Exists(PlayerFilePath))
             {
                 File.Delete(PlayerFilePath);
             }
 
             Clear();
         }

Here is the caller graph for this function:

◆ Deserialize()

bool BGC.Users.ProfileData.Deserialize ( )

inline

Load user contents from file

Definition at line 298 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey(), and BGC.IO.FileReader.ReadJsonFile().

Referenced by BGC.Users.PlayerData.DeleteUserData(), BGC.Users.PlayerData.GetMigrationData(), and BGC.Users.PlayerData.LogIn().

         {
             return FileReader.ReadJsonFile(
                 path: PlayerFilePath,
                 //If it is parsable, mark it as successfully loaded
                 successCallback: (JsonObject readData) =>
                 {
                     if (readData.ContainsKey("UserDicts"))
                     {
                         userData = readData["UserDicts"];
                     }
                 });
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetBool()

bool BGC.Users.ProfileData.GetBool	(	string	key,
		bool	defaultReturn = `false`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 193 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

Referenced by BGC.Users.PlayerData.GetMigrationData().

         {
             if (userData.ContainsKey(key))
             {
                 if (userData[key].IsBoolean)
                 {
                     return userData[key].AsBoolean;
                 }
                 else if (userData[key].IsInteger)
                 {
                     return userData[key].AsInteger != 0;
                 }
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ GetDouble()

double BGC.Users.ProfileData.GetDouble	(	string	key,
		double	defaultReturn = `0.0`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 224 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) && userData[key].IsNumber)
             {
                 return userData[key].AsNumber;
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

◆ GetFloat()

float BGC.Users.ProfileData.GetFloat	(	string	key,
		float	defaultReturn = `0f`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 212 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) && userData[key].IsNumber)
             {
                 return (float)userData[key].AsNumber;
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

◆ GetInt()

int BGC.Users.ProfileData.GetInt	(	string	key,
		int	defaultReturn = `0`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 181 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) && userData[key].IsInteger)
             {
                 return userData[key].AsInteger;
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

◆ GetJsonArray()

JsonArray BGC.Users.ProfileData.GetJsonArray	(	string	key,
		JsonArray	defaultReturn = `default(JsonArray)`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 260 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey(), and LightJson.JsonObject.Remove().

         {
             if (userData.ContainsKey(key))
             {
                 return userData[key];
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

◆ GetJsonValue()

JsonValue BGC.Users.ProfileData.GetJsonValue	(	string	key,
		JsonValue	defaultReturn = `default(JsonValue)`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 248 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key))
             {
                 return userData[key];
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

◆ GetString()

string BGC.Users.ProfileData.GetString	(	string	key,
		string	defaultReturn = `""`
	)

inline

Get value associated with indicated key

Parameters

defaultReturn The value to return if the key is not present in dictionary

Definition at line 236 of file ProfileData.cs.

References LightJson.JsonObject.ContainsKey().

Referenced by BGC.Users.PlayerData.GetMigrationData().

         {
             if (userData.ContainsKey(key) && userData[key].IsString)
             {
                 return userData[key].AsString;
             }
 
             return defaultReturn;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ HasKey()

bool BGC.Users.ProfileData.HasKey ( string key )

Get if any value is associated with indicated key

◆ RemoveKey()

void BGC.Users.ProfileData.RemoveKey ( string key )

Remove any value is associated with indicated key

◆ Serialize()

void BGC.Users.ProfileData.Serialize ( )

inline

Save contents to file

Definition at line 277 of file ProfileData.cs.

References BGC.IO.FileWriter.WriteJson().

Referenced by BGC.Users.PlayerData.AddUser().

         {
             //Don't serialize out blank usernames
             if (UserName.CompareTo("") == 0)
             {
                 Debug.LogError("Tried to serialize out a profile with a blank username.");
                 return;
             }
 
             FileWriter.WriteJson(
                 path: PlayerFilePath,
                 createJson: () => new JsonObject
                 {
                     { "Version", userDataSerializationVersion },
                     { "UserName", UserName },
                     { "UserDicts", userData }
                 },
                 pretty: true);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ SetBool()

void BGC.Users.ProfileData.SetBool	(	string	key,
		bool	value
	)

inline

Set value at indicated key

Definition at line 59 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Check existing data for type match
                 if (userData[key].IsBoolean == false)
                 {
                     if (userData[key].IsInteger)
                     {
                         Debug.LogWarning($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to Bool");
                     }
                     else
                     {
                         Debug.LogError($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to Bool");
                     }
                 }
 
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetDouble()

void BGC.Users.ProfileData.SetDouble	(	string	key,
		double	value
	)

inline

Set value at indicated key

Definition at line 129 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Check existing data for type match
                 if (userData[key].IsNumber == false)
                 {
                     Debug.LogError($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to Number");
                 }
 
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetFloat()

void BGC.Users.ProfileData.SetFloat	(	string	key,
		float	value
	)

inline

Set value at indicated key

Definition at line 108 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Check existing data for type match
                 if (userData[key].IsNumber == false)
                 {
                     Debug.LogError($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to Number");
                 }
 
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetInt()

void BGC.Users.ProfileData.SetInt	(	string	key,
		int	value
	)

inline

Set value at indicated key

Definition at line 37 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Check existing data for type match
                 if (userData[key].IsInteger == false)
                 {
                     Debug.LogError($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to Int");
                 }
 
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetJsonArray()

void BGC.Users.ProfileData.SetJsonArray	(	string	key,
		JsonArray	value
	)

inline

Set value at indicated key

Definition at line 165 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetJsonValue()

void BGC.Users.ProfileData.SetJsonValue	(	string	key,
		JsonValue	value
	)

inline

Set value at indicated key

Definition at line 150 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

◆ SetString()

void BGC.Users.ProfileData.SetString	(	string	key,
		string	value
	)

inline

Set value at indicated key

Definition at line 87 of file ProfileData.cs.

References LightJson.JsonObject.Add(), and LightJson.JsonObject.ContainsKey().

         {
             if (userData.ContainsKey(key) == false)
             {
                 //Data did not exist - add it
                 userData.Add(key, value);
             }
             else
             {
                 //Check existing data for type match
                 if (userData[key].IsString == false)
                 {
                     Debug.LogError($"PlayerData \"{key}\" Datatype changed from {userData[key].Type.ToString()} to String");
                 }
 
                 //Set data
                 userData[key] = value;
             }
         }

Here is the call graph for this function:

Field Documentation

◆ PlayerFilePath

string BGC.Users.ProfileData.PlayerFilePath

protected

Initial value:

=> DataManagement.PathForDataFile(
            dataDirectory: PlayerData.UserDataDir,
            fileName: FileExtensions.AddJsonExtension(UserName))

Path of the user datafile

Definition at line 26 of file ProfileData.cs.

◆ userData

JsonObject BGC.Users.ProfileData.userData = new JsonObject()

private

Definition at line 13 of file ProfileData.cs.

◆ userDataSerializationVersion

const int BGC.Users.ProfileData.userDataSerializationVersion = 1

private

Definition at line 15 of file ProfileData.cs.

Property Documentation

◆ IsDefault

abstract bool BGC.Users.ProfileData.IsDefault

get

Is this an instance of default data?

Definition at line 23 of file ProfileData.cs.

◆ UserName

string BGC.Users.ProfileData.UserName

get

Definition at line 11 of file ProfileData.cs.

Referenced by BGC.Users.PlayerData.GetMigrationData().

The documentation for this class was generated from the following file:

Users/ProfileData.cs

Public Member Functions

Protected Attributes

Properties

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ ProfileData()

Member Function Documentation

◆ Clear()

◆ DeletePlayerData()

◆ Deserialize()

◆ GetBool()

◆ GetDouble()

◆ GetFloat()

◆ GetInt()

◆ GetJsonArray()

◆ GetJsonValue()

◆ GetString()

◆ HasKey()

◆ RemoveKey()

◆ Serialize()

◆ SetBool()

◆ SetDouble()

◆ SetFloat()

◆ SetInt()

◆ SetJsonArray()

◆ SetJsonValue()

◆ SetString()

Field Documentation

◆ PlayerFilePath

◆ userData

◆ userDataSerializationVersion

Property Documentation

◆ IsDefault

◆ UserName