#53 and tidied up Log calls

Author: jackbrookes

Assets/UXF/Prefabs/[UXF_Rig].prefab

@@ -93,6 +93,8 @@ MonoBehaviour:
   m_Script: {fileID: 11500000, guid: 325d8bc56dfbdf4439627ee58ed3a5a4, type: 3}
   m_Name: 
   m_EditorClassIdentifier: 
+  setAsMainInstance: 1
+  logDebugLogCalls: 1
 --- !u!1 &64655937078549661
 GameObject:
   m_ObjectHideFlags: 0

Assets/UXF/Scripts/DataHandling/FileSaver.cs

@@ -55,7 +55,7 @@ public override void SetUp()
             }
             else
             {
-                Debug.LogWarning("Parallel thread is still active!");
+                Utilities.UXFDebugLogWarning("Parallel thread is still active!");
             }
         }
 
@@ -84,13 +84,13 @@ public void ManageInWorker(System.Action action)
         void Worker()
         {
             if (verboseDebug)
-                Debug.Log("Started worker thread");
+                Utilities.UXFDebugLog("Started worker thread");
 
             // performs FileIO tasks in seperate thread
             foreach (var action in bq)
             {
                 if (verboseDebug)
-                    Debug.LogFormat("Managing action");
+                    Utilities.UXFDebugLogFormat("Managing action");
 
                 try
                 {
@@ -102,7 +102,7 @@ void Worker()
                 }
                 catch (IOException e)
                 {
-                    Debug.LogError(string.Format("Error, file may be in use! Exception: {0}", e));
+                    Utilities.UXFDebugLogError(string.Format("Error, file may be in use! Exception: {0}", e));
                 }
                 catch (System.Exception e)
                 {
@@ -115,7 +115,7 @@ void Worker()
             }
 
             if (verboseDebug)
-                Debug.Log("Finished worker thread");
+                Utilities.UXFDebugLog("Finished worker thread");
         }
 
         /// <summary>
@@ -143,7 +143,7 @@ public override string HandleDataTable(UXFDataTable table, string experiment, st
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.csv", dataName));
 
-            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Utilities.UXFDebugLogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllLines(savePath, lines); });
             return GetRelativePath(storagePath, savePath);;
@@ -160,7 +160,7 @@ public override string HandleJSONSerializableObject(List<object> serializableObj
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.json", dataName));
 
-            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Utilities.UXFDebugLogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllText(savePath, text); });
             return GetRelativePath(storagePath, savePath);;
@@ -177,7 +177,7 @@ public override string HandleJSONSerializableObject(Dictionary<string, object> s
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.json", dataName));
 
-            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Utilities.UXFDebugLogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllText(savePath, text); });
             return GetRelativePath(storagePath, savePath);;
@@ -192,7 +192,7 @@ public override string HandleText(string text, string experiment, string ppid, i
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.txt", dataName));
 
-            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Utilities.UXFDebugLogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllText(savePath, text); });
             return GetRelativePath(storagePath, savePath);;
@@ -207,7 +207,7 @@ public override string HandleBytes(byte[] bytes, string experiment, string ppid,
             Directory.CreateDirectory(directory);
             string savePath = Path.Combine(directory, string.Format("{0}.txt", dataName));  
 
-            if (verboseDebug) Debug.LogFormat("Queuing save of file: {0}", savePath);
+            if (verboseDebug) Utilities.UXFDebugLogFormat("Queuing save of file: {0}", savePath);
 
             ManageInWorker(() => { File.WriteAllBytes(savePath, bytes); });
             return GetRelativePath(storagePath, savePath);
@@ -221,7 +221,7 @@ public string GetSessionPath(string experiment, string ppid, int sessionNum)
             {
                 storageLocationSafe = Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.UserProfile), "UXF_Data");
                 Directory.CreateDirectory(storageLocationSafe);
-                Debug.LogErrorFormat("Selected storage location ({0}) does not exist! Defaulting to {1}.", base.storagePath, storageLocationSafe);
+                Utilities.UXFDebugLogErrorFormat("Selected storage location ({0}) does not exist! Defaulting to {1}.", base.storagePath, storageLocationSafe);
             }
             return Path.Combine(storageLocationSafe, experiment, ppid, SessionNumToName(sessionNum));
         }
@@ -238,7 +238,7 @@ public static string SessionNumToName(int num)
         public override void CleanUp()
         {
             if (verboseDebug)
-                Debug.Log("Joining File Saver Thread");
+                Utilities.UXFDebugLog("Joining File Saver Thread");
             quitting = true;
             bq.Enqueue(doNothing); // ensures bq breaks from foreach loop
             parallelThread.Join();

Assets/UXF/Scripts/DataHandling/WebAWSDynamoDB.cs

@@ -62,7 +62,7 @@ public override void SetUp()
         {
             bool ok = CheckCurrentTargetOK();
             if (!ok) return;
-            if (credentials == null) Debug.LogError("Credentials have not been set!");
+            if (credentials == null) Utilities.UXFDebugLogError("Credentials have not been set!");
             DDB_Setup(credentials.region, credentials.cognitoIdentityPool, gameObject.name);
 
             var allDataTypes = Enum.GetValues(typeof(UXFDataType)); 
@@ -86,11 +86,10 @@ void AddBrowserInfo()
                 if (!session.participantDetails.ContainsKey(kvp.Key))
                 {
                     session.participantDetails.Add(kvp.Key, kvp.Value);
-                    Debug.LogFormat("{0}: {1}", kvp.Key, kvp.Value);
                 }
                 else
                 {
-                    Debug.LogErrorFormat("participantDetails already contains key \"{0}\"!", kvp.Key);
+                    Utilities.UXFDebugLogErrorFormat("participantDetails already contains key \"{0}\"!", kvp.Key);
                 }
             }
         }
@@ -123,7 +122,7 @@ public override string HandleDataTable(UXFDataTable table, string experiment, st
 
                 if (!table.Headers.Contains("trial_num"))
                 {
-                    Debug.LogError("Data supplied is supposed to be per-trial but does not contain 'trial_num' column!");
+                    Utilities.UXFDebugLogError("Data supplied is supposed to be per-trial but does not contain 'trial_num' column!");
                     return "error";
                 }
                 var dataList = table.GetAsListOfDict()
@@ -347,12 +346,12 @@ public void GetCustomDataFromDB(string tableName, string primaryKeyName, object
 
         private void ShowError(string text)
         {
-            Debug.LogError(text);
+            Utilities.UXFDebugLogError(text);
         }
 
         private void HandleSuccessfulDBRead(string jsonResult)
         {
-            Debug.Log(jsonResult);
+            Utilities.UXFDebugLog(jsonResult);
             Dictionary<string, object> jsonRequest = (Dictionary<string, object>) MiniJSON.Json.Deserialize(jsonResult);
             string guid = (string) jsonRequest["guid"];
             Action<Dictionary<string, object>> callback = requestCallbackMap[guid];
@@ -408,9 +407,9 @@ private bool CheckCurrentTargetOK()
             var buildTarget = UnityEditor.EditorUserBuildSettings.activeBuildTarget;
             if (buildTarget != UnityEditor.BuildTarget.WebGL)
             {
-                Debug.LogError("Web AWS DynamoDB Data Handler is not compatible with current build target. Please switch your platform in Build Settings to WebGL if you wish to use this.");
+                Utilities.UXFDebugLogError("Web AWS DynamoDB Data Handler is not compatible with current build target. Please switch your platform in Build Settings to WebGL if you wish to use this.");
             }
-            Debug.LogWarning("Unfortunately the Web AWS DynamoDB Data Handler cannot communicate with the database whilst running in the Unity Editor, because it relies on the AWS JavaScript SDK. To test data upload, create a build of your application and test it in a web browser. You can still test in the Unity Editor without database access.");
+            Utilities.UXFDebugLogWarning("Unfortunately the Web AWS DynamoDB Data Handler cannot communicate with the database whilst running in the Unity Editor, because it relies on the AWS JavaScript SDK. To test data upload, create a build of your application and test it in a web browser. You can still test in the Unity Editor without database access.");
             return false;
 # else
             return true;

Assets/UXF/Scripts/Etc/AWSCredentials.cs

@@ -18,12 +18,12 @@ public bool CheckIfValidFormat()
         {
             if (region == string.Empty)
             {
-                Debug.LogError("Region in AWS Credentials is blank! Please supply your region (e.g. eu-west-2)");
+                Utilities.UXFDebugLogError("Region in AWS Credentials is blank! Please supply your region (e.g. eu-west-2)");
                 return false;
             }
             if (cognitoIdentityPool == string.Empty)
             {
-                Debug.LogError("Cognito Identity Pool in AWS Credentials is blank! Please supply your Cognito Identity Pool (e.g. eu-west-2:00000000-0000-0000-0000-000000000000)");
+                Utilities.UXFDebugLogError("Cognito Identity Pool in AWS Credentials is blank! Please supply your Cognito Identity Pool (e.g. eu-west-2:00000000-0000-0000-0000-000000000000)");
                 return false;
             }
             return true;

Assets/UXF/Scripts/Etc/Editor/DataHandlerDrawer.cs

@@ -44,7 +44,7 @@ public override void OnGUI(Rect position, SerializedProperty property, GUIConten
             {
                 var obj = new SerializedObject(property.objectReferenceValue);
                 var prop = obj.FindProperty("active");
-                if (EditorGUI.PropertyField(activeBox, prop, GUIContent.none)) Debug.Log("df");
+                if (EditorGUI.PropertyField(activeBox, prop, GUIContent.none)) { }
                 obj.ApplyModifiedProperties();
                 name = dh.name;
             }

Assets/UXF/Scripts/Etc/Editor/UIControllerEditor.cs

@@ -230,30 +230,30 @@ public void HaltPlayIfUIIsInvalid(PlayModeStateChange state)
                 {
                     EditorApplication.isPlaying = false;
                     string errorText = "Incompatibility Error: " + ppidReasonText;
-                    Debug.LogError(errorText);
+                    Utilities.UXFDebugLogError(errorText);
                 }
 
                 string settingsReasonText;
                 if (!uiController.SettingsModeIsValid(out settingsReasonText))
                 {
                     EditorApplication.isPlaying = false;
                     string errorText = "Incompatibility Error: " + settingsReasonText;
-                    Debug.LogError(errorText);
+                    Utilities.UXFDebugLogError(errorText);
                 }
 
                 string datapointsReasonText;
                 if (!uiController.DatapointsAreValid(out datapointsReasonText))
                 {
                     EditorApplication.isPlaying = false;
                     string errorText = "Incompatibility Error: " + datapointsReasonText;
-                    Debug.LogError(errorText);
+                    Utilities.UXFDebugLogError(errorText);
                 }
 
                 string localPathStateReasonText;
                 if (!uiController.LocalPathStateIsValid(out localPathStateReasonText))
                 {
                     string errorText = "Incompatibility Error: " + localPathStateReasonText;
-                    Debug.LogError(errorText);
+                    Utilities.UXFDebugLogError(errorText);
                 }
             }
         }

Assets/UXF/Scripts/Etc/Editor/UXFBuildPreprocessor.cs

@@ -22,7 +22,7 @@ class UXFBuildPreprocessor : IProcessSceneWithReport
         public void OnProcessScene(Scene scene, BuildReport report)
         {
             if (report == null) return;
-            Debug.LogFormat("UXF is pre-processing your built scene '{0}' for platform '{1}' to make sure settings are compatible with the build... ", scene.name, report.summary.platform);
+            Utilities.UXFDebugLogFormat("UXF is pre-processing your built scene '{0}' for platform '{1}' to make sure settings are compatible with the build... ", scene.name, report.summary.platform);
 
             var uis = scene
                 .GetRootGameObjects()
@@ -31,7 +31,7 @@ public void OnProcessScene(Scene scene, BuildReport report)
             if (report.summary.platform == BuildTarget.WebGL &&
                     PlayerSettings.WebGL.template != "PROJECT:UXF WebGL")
             {
-                Debug.LogWarning("The UXF WebGL template is not selected in WebGL player settings! This may lead to errors. You can fix the is with the UXF Wizard (press UXF at the top, Show UXF Wizard).");
+                Utilities.UXFDebugLogWarning("The UXF WebGL template is not selected in WebGL player settings! This may lead to errors. You can fix the is with the UXF Wizard (press UXF at the top, Show UXF Wizard).");
             }
 
             foreach (var ui in uis)
@@ -79,7 +79,7 @@ public void OnProcessScene(Scene scene, BuildReport report)
 
                     if (!compatible && !incompatible)
                     {
-                        Debug.LogWarningFormat(
+                        Utilities.UXFDebugLogWarningFormat(
                             "Warning: (Scene: {0}) - The data handler '{1}' has not reported either compatibility or incompatibility with platform group '{2}'. Use at your own risk!",
                             scene.name, 
                             dh.name, 

Assets/UXF/Scripts/Etc/Trial.cs

@@ -103,7 +103,7 @@ public void Begin()
                 }
                 catch (NullReferenceException)
                 {
-                    Debug.LogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
+                    Utilities.UXFDebugLogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
                 }
             }
             session.onTrialBegin.Invoke(this);
@@ -137,7 +137,7 @@ public void End()
                 }
                 catch (NullReferenceException)
                 {
-                    Debug.LogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
+                    Utilities.UXFDebugLogWarning("An item in the Tracked Objects field of the UXF session if empty (null)!");
                 }
             }
 
@@ -154,7 +154,7 @@ public bool CheckDataTypeIsValid(string dataName, UXFDataType dataType)
         {
             if (dataType.GetDataLevel() != UXFDataLevel.PerTrial)
             {
-                Debug.LogErrorFormat(
+                Utilities.UXFDebugLogErrorFormat(
                     "Error trying to save data '{0}' of type UXFDataType.{1} associated with the Trial. The valid types for this method are {2}. Reverting to type UXFDataType.OtherTrialData.",
                     dataName,
                     dataType,

Assets/UXF/Scripts/Etc/Utilities.cs

@@ -0,0 +1,25 @@
+using UnityEngine;
+using System.Collections;
+using System.Collections.Generic;
+
+namespace UXF
+{
+    /// <summary>
+    /// Useful methods
+    /// </summary>
+    public static class Utilities
+    {
+
+        public static void UXFDebugLog(string message) { Debug.Log(UXFFormatString(message)); }
+        public static void UXFDebugLogWarning(string message) { Debug.LogWarning(UXFFormatString(message)); }
+        public static void UXFDebugLogError(string message) { Debug.LogError(UXFFormatString(message)); }
+        public static void UXFDebugLogFormat(string format, params object[] args) { Debug.LogFormat(UXFFormatString(format), args); }
+        public static void UXFDebugLogWarningFormat(string format, params object[] args) { Debug.LogWarningFormat(UXFFormatString(format), args); }
+        public static void UXFDebugLogErrorFormat(string format, params object[] args) { Debug.LogErrorFormat(UXFFormatString(format), args); }
+
+
+        private static string UXFFormatString(string message) { return string.Format("[<b><color=#AD477C>UXF</color></b>] {0}", message); }
+
+    }       
+
+}