using System;

using UnityEngine;

namespace Framework.Dialogue {

  /// <summary>Container for the result returned by a dialogue placement search</summary>
  public struct DialoguePlacement {

    /// <summary>Initialize a new dialogue UI transform + prefab container</summary>
    /// <param name="actor">Actor the dialogue UI is being displayed for</param>
    /// <param name="owner">GameObject that owns the dialogue UI</param>
    /// <param name="transform">Transform the dialogue UI should be placed at</param>
    public DialoguePlacement(
      GameObject actor, DialogueOwner owner, Transform transform
    ) {
      this.Actor = actor;
      this.Owner = owner;
      this.Transform = transform;
    }

    /// <summary>Actor the dialogue UI will be displayed for, if any</summary>
    /// <remarks>
    ///   This can be used to query addition information, such as a portrait or
    ///   the current state of the actor.
    /// </remarks>
    public GameObject Actor;

    /// <summary>Owner on which the placement was discovered</summary>
    public DialogueOwner Owner;

    /// <summary>Location and orientation the dialogue canvas should be shown at</summary>
    public Transform Transform;

  }

} // namespace Framework.Dialogue