Tracker.Trace(...) methods are prone to failure (sould be Obsolete)

[RotaruDan]

Problem

The methods

public void Trace (params string[] values)

and

public void Trace (string trace)

Available at Tracker.cs are prone to failure because they require to be invoked with exactly 3 arguments in a specific order, as we can see below.

For the method:

public void Trace (params string[] values)

1. Verb: String, e.g. "initialized"
2. TargetId: String, e.g. "my_quest_mission"
3. TargetType. String, e.g. "completable"

For the method:

public void Trace (string trace)

1. CSV: String, e.g. "initialized", "completable", "my_quest_mission"

Any other invocation would result in failure.

[RotaruDan]

Solution

1. We will create a new method with a well defined signature

    /// <summary>
    /// Adds a trace with the specified values
    /// Type = GameObject 
    /// </summary>
    /// <param name="verb">Verb: String, e.g. "initialized"</param>
    /// <param name="targetType">Verb: String, e.g. "completable"</param>
    /// <param name="TargetId">Verb: String, e.g. "my_quest_mission"</param>
    public void Trace (string verb, string targetType, string targetId)

2. Mark as obsolete the previous methods:

[Obsolete("Trace (params string[] values) and Trace (string trace) are deprecated, please use Trace (string verb, string targetType, string targetId) instead.", true)]