friendlyUnitLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file friendlyUnitLogic.h
//! \brief Defines the DtFriendlyUnitsLogic component for tracking friendly units in the simulation.
//!
//! This component listens for EntityFriendlyUnitsMessages and maintains a list of friendly units
//! that can be accessed via state attributes. This is particularly useful for command roles
//! that need to know what friendly units are available for tasking.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
 
#include "vrePlayerStation/playerComponent.h"
#include <vreMessageManager/vreMessage.h>
 
 
namespace makVre
{
//! \brief Type identifier for DtFriendlyUnitsLogic component
constexpr const char* DtFriendlyUnitsLogicType = "DtFriendlyUnitsLogic";
 
//! \brief Component for tracking friendly units in the simulation
//!
//! The DtFriendlyUnitsLogic listens for EntityFriendlyUnitsMessages and maintains
//! a list of friendly units via state attributes. When a message is received, the component
//! updates the "subordinateList" and "taskableEntities" state attributes with the
//! list of friendly units and a flag indicating whether any are available, respectively.
//!
//! This component is particularly useful in command roles where it's important to know
//! what friendly units can be tasked or interacted with.
class VRECOMMONCOMPONENTS_DLL DtFriendlyUnitsLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtFriendlyUnitsLogic
   //!
   //! Initializes the component with the name "DtFriendlyUnitsLogic".
   DtFriendlyUnitsLogic();
 
   //! \brief Virtual destructor for DtFriendlyUnitsLogic
   virtual ~DtFriendlyUnitsLogic() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Sets up a message handler for EntityFriendlyUnitsMessages.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters
   //! \return True if initialization succeeds
   virtual bool initialize(DtPlayerStation* player, DtInitTable& config) override;
 
   //! \brief Performs post-initialization setup
   //!
   //! Currently just returns true as there's no additional setup needed.
   //!
   //! \return True, indicating successful post-initialization
   virtual bool postInitialize() 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
   //!
   //! Removes the EntityFriendlyUnitsMessage handler.
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtFriendlyUnitsLogic
   virtual const char* type() const override;
 
protected:
   //! \brief Initializes state attributes (empty implementation)
   //!
   //! This method is reserved for initializing state attributes, but currently
   //! has an empty implementation with commented-out code for potential future use.
   virtual void initializeStateAttributes() override;
 
   //! \brief Handles messages about friendly units
   //!
   //! Processes EntityFriendlyUnitsMessages by extracting the list of friendly units
   //! and updating the "subordinateList" and "taskableEntities" state attributes.
   //!
   //! \param msg The message to process
   //! \return HANDLED if the message was processed successfully, IGNORED otherwise
   DtVreMessageResult handleFriendlyUnitsMessage(DtVreMessage* msg);
 
   // Commented out attributes for future use
   //! \brief Pointer to the subordinate list attribute (commented out)
   // DtAttribute<std::vector<std::string>>* mySubordinateListAttr;
 
   //! \brief Pointer to the taskable entities flag attribute (commented out)
   // DtAttribute<bool>* myTaskableEntitiesAttr;
};
 
} // namespace makVre