#pragma once

/// \file number_value.h
/// \author Folling <folling@ikarus.world>

#include <ikarus/macros.h>

/// \addtogroup entity_value Entity Values
/// @{

IKARUS_BEGIN_HEADER

/// \brief A true/false boolean-like value. For example "IsDead".
struct IkarusNumberValue;

/// \brief Creates a number value from a long double.
/// \param value The numeric value.
/// \return The entity value.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusNumberValue * ikarus_number_value_create(long double value);

/// \brief Creates an indeterminate number value.
/// \return The entity value.
/// \remark Must be freed with #ikarus_free.
IKA_API IkarusNumberValue * ikarus_number_value_create_indeterminate();

/// \brief Sets the value of a number value.
/// \param value The number value.
/// \pre \li Must not be null.
/// \param new_value The new value.
IKA_API void ikarus_number_value_set(IkarusNumberValue * value, bool new_value);

/// \brief Fetches the underlying value of a number value.
/// \param value The number value.
/// \return The underlying value.
/// \warning If the value is indeterminate, false is returned.
IKA_API long double ikarus_number_value_get_underlying(IkarusNumberValue const * value);

/// \brief Converts a number value to an entity value.
/// \param number_value The number value to convert.
/// \return The converted entity value.
IKA_API struct IkarusEntityValue * ikarus_number_value_to_entity_value(IkarusNumberValue * number_value);

IKARUS_END_HEADER