summaryrefslogtreecommitdiff
path: root/VRCSDK3Worlds/Assets/Udon/Serialization/OdinSerializer/Config/GlobalSerializationConfig.cs
blob: bb3b2b5cc40d77255053897ca8b1ffedf9295d34 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
//-----------------------------------------------------------------------
// <copyright file="GlobalSerializationConfig.cs" company="Sirenix IVS">
// Copyright (c) 2018 Sirenix IVS
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// </copyright>
//-----------------------------------------------------------------------
namespace VRC.Udon.Serialization.OdinSerializer
{
    /// <summary>
    /// Contains global configuration options for the serialization system.
    /// </summary>
    public class GlobalSerializationConfig
    {
        private static readonly GlobalSerializationConfig instance = new GlobalSerializationConfig();

        /// <summary>
        /// Gets the global configuration instance.
        /// </summary>
        public static GlobalSerializationConfig Instance { get { return GlobalSerializationConfig.instance; } }

        /// <summary>
        /// Gets the logger.
        /// </summary>
        public ILogger Logger { get { return DefaultLoggers.UnityLogger; } }

        /// <summary>
        /// Gets the editor serialization format.
        /// </summary>
        public DataFormat EditorSerializationFormat { get { return DataFormat.Nodes; } }

        /// <summary>
        /// Gets the build serialization format.
        /// </summary>
        public DataFormat BuildSerializationFormat { get { return DataFormat.Binary; } }

        /// <summary>
        /// Gets the logging policy.
        /// </summary>
        public LoggingPolicy LoggingPolicy { get { return LoggingPolicy.LogErrors; } }

        /// <summary>
        /// Gets the error handling policy.
        /// </summary>
        public ErrorHandlingPolicy ErrorHandlingPolicy { get { return ErrorHandlingPolicy.Resilient; } }

        internal static void LoadInstanceIfAssetExists()
        {
            // TODO: @Integration: If you store your config in an asset or file somewhere, load it here.
        }

        internal static bool HasInstanceLoaded
        {
            get
            {
                // TODO: @Integration: If you store your config in an asset or file somewhere, return true here if it is loaded, otherwise false.
                // If your config is stored in a Unity asset, do NOT load it here; this property is often called from the
                // serialization thread, meaning you are not allowed to use Unity's API for loading assets here.
                // If this value is false, default configuration values will be used - the same defaults as are set in this class.
                return true;
            }
        }
    }
}