#pragma once
#pragma region CPL License
/*
Nuclex Unreal Module
Copyright (C) 2014-2021 Nuclex Development Labs

This library is free software; you can redistribute it and/or
modify it under the terms of the IBM Common Public License as
published by the IBM Corporation; either version 1.0 of the
License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
IBM Common Public License for more details.

You should have received a copy of the IBM Common Public
License along with this library
*/
#pragma endregion // CPL License

#include <CoreMinimal.h>

// --------------------------------------------------------------------------------------------- //

/// States the paragraph box can be in
/// @remarks
///   Current state is exposed by paragraph boxes through the VisualNovelParagraphBox
///   interface and consumed by the visual novel story controller to wait before showing
///   new dialogue.
///
///   When implementing custom paragraph boxes, this state should be carefully and accurately
///   managed to avoid dialogue softlocks.
UENUM(BlueprintType)
enum class EParagraphBoxAnimationState : uint8 {

  /// Paragraph box is not visible
  Hidden = 0 UMETA(DisplayName = "Paragraph hidden"),

  /// Paragraph box is playing its appear animation
  Appearing = 129 UMETA(DisplayName = "Playing appear animation"),

  /// Paragraph box is waiting for the player to confirm or make a choice
  AwaitingConfirmation = 2 UMETA(DisplayName = "Waiting for player confirmation or choice"),

  /// The paragraph box is open and the player has acknowledged it
  Confirmed = 3 UMETA(DisplayName = "Paragraph is visible and confirmed"),

  /// Paragraph box is playing its hide animation
  Hiding = 132 UMETA(DisplayName = "Playing hide animation"),

};

// --------------------------------------------------------------------------------------------- //