extendedStateLogic.h

Go to the documentation of this file.

/*******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
*******************************************************************************/
 
//! \file extendedStateLogic.h
//! \brief Defines the DtExtendedStateLogic component for managing extended state attributes.
//!
//! This component allows for the dynamic addition of state attributes beyond the standard set,
//! supporting various data types and custom properties for simulation monitoring and control.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
 
#include <string>
#include <vector>
 
namespace makVre
{
 
namespace ExtendedStateLogicConfig
{
//! \ingroup RoleConfigParams
//! \defgroup ExtendedStateLogicRoleParams Extended State Logic Role Parameters
//! \roleInherits{PlayerComponentRoleParams}
//! Configuration Options for extended state logic component.
//! @{
 
//! \vreRoleParam{extendedState,table,{},extendedStateLogic,Table containing definitions for extended state attributes with name and type fields.}
constexpr const char* extendedState = "extendedState";
 
//! \vreRoleParam{stateProperties,table,{},extendedStateLogic,Table containing definitions for state properties with name and type fields.}
constexpr const char* stateProperties = "stateProperties";
 
//! @}
} // namespace ExtendedStateLogicConfig
 
//! \brief Forward declaration of the initialization table class
class DtInitTable;
 
//! \brief Type identifier for DtExtendedStateLogic component
constexpr const char* DtExtendedStateLogicType = "DtExtendedStateLogic";
 
//! \brief Component for managing extended state attributes beyond the standard set
//!
//! The DtExtendedStateLogic component provides functionality to dynamically add custom
//! state attributes to an entity. These attributes can be configured in Lua and support
//! various data types (int, float, double, string, bool, ammoClipMap).
//!
//! This component is particularly useful for simulation monitoring and sharing state
//! information that isn't covered by the standard state attributes. It will send an
//! ExtendedStateMonitorInitMessage to notify the system of these additional attributes.
class VRECOMMONCOMPONENTS_DLL DtExtendedStateLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtExtendedStateLogic
   //!
   //! Initializes the component with the name "DtExtendedStateLogic".
   DtExtendedStateLogic();
 
   //! \brief Virtual destructor for DtExtendedStateLogic
   virtual ~DtExtendedStateLogic() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Processes the "extendedState" and "stateProperties" sections from the configuration,
   //! creating state attributes based on their specifications. For each attribute defined,
   //! the component will:
   //! - Add the attribute to the player's attribute store
   //! - Send an ExtendedStateMonitorInitMessage to register the attribute with the system
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing attribute definitions
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(makVre::DtPlayerStation* player, makVre::DtInitTable& config) override;
 
   //! \brief Updates the component state (empty implementation)
   //!
   //! This method is called each frame but currently has no implementation.
   //!
   //! \param dt Delta time in seconds since the last tick
   virtual void tick(double dt) override;
 
   //! \brief Shuts down the component
   //!
   //! Sends an ExtendedStateMonitorInitMessage with a null entity ID to
   //! deregister the extended state attributes.
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtExtendedStateLogic
   virtual const char* type() const override;
 
protected:
   //! \brief Adds custom attributes to the player's attribute store
   //!
   //! Creates attributes in the player's attribute store based on the provided names
   //! and types. Supports the following data types:
   //! - int: Initialized to 0
   //! - float: Initialized to 0.0f
   //! - double: Initialized to 0.0
   //! - string: Initialized to "not set"
   //! - bool: Initialized to false
   //! - ammoClipMap: Special case that requires no initialization
   //!
   //! \param names Vector of attribute names to add
   //! \param types Vector of attribute types corresponding to the names
   void addAdditionalAttributesToState(std::vector<std::string>& names, std::vector<std::string>& types);
};
} // namespace makVre