disembarkControlLogic.h

Go to the documentation of this file.

/******************************************************************************
** Copyright (c) 2025 MAK Technologies
** All rights reserved.
******************************************************************************/
 
//! \file disembarkControlLogic.h
//! \brief Defines the DtDisembarkControlLogic component for handling entity disembarkation.
//!
//! This component provides functionality for disembarking (exiting) from a vehicle
//! or other parent entity, handling both actual simulation disembarkation and role selection logic.
//!
//! \ingroup vreCommonComponents
 
#pragma once
 
#include "vreCommonComponents/export.h"
#include "vrePlayerStation/playerComponent.h"
#include "vreMessageManager/vreMessage.h"
 
namespace makVre
{
 
//! \brief Type identifier for DtDisembarkControlLogic component
constexpr const char* DtDisembarkControlLogicType = "DtDisembarkControlLogic";
 
//! \brief Component for handling entity disembarkation
//!
//! The DtDisembarkControlLogic component provides functionality for disembarking
//! (exiting) from a vehicle or other parent entity. It handles the "disembark" action
//! from the menu system and sends appropriate messages to either trigger actual
//! disembarkation in the simulation or to return to the role selection screen.
//!
//! The behavior depends on whether the current role is stacked on another role
//! (typically a Human role) or if it is a standalone role.
class VRECOMMONCOMPONENTS_DLL DtDisembarkControlLogic : public DtPlayerComponent
{
public:
   //! \brief Constructor for DtDisembarkControlLogic
   //!
   //! Initializes the component with default values.
   DtDisembarkControlLogic();
 
   //! \brief Virtual destructor for DtDisembarkControlLogic
   virtual ~DtDisembarkControlLogic() override;
 
   //! \brief Initializes the component with configuration from Lua
   //!
   //! Sets up a message handler for the MenuActionMessage type and determines
   //! whether this role is stacked on a base role or is standalone.
   //!
   //! \param player Pointer to the player station this component belongs to
   //! \param config Configuration table containing initialization parameters
   //! \return True if initialization succeeds, false otherwise
   virtual bool initialize(DtPlayerStation* player, 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
   //!
   //! Removes the MenuActionMessage handler to prevent duplicate processing.
   virtual void shutdown() override;
 
   //! \brief Returns the type identifier for this component
   //! \return The type string for DtDisembarkControlLogic
   virtual const char* type() const override;
 
   //! \brief Handles menu action messages
   //!
   //! Processes the "disembark" menu action. If this is a stacked role, sends a
   //! VrfSetEmbarkMessage to disembark the base player from its parent entity.
   //! If this is a standalone role, sends a UIChooseRoleButtonClickedMessage to
   //! return to the role selection screen.
   //!
   //! After processing the disembark action, removes itself as a handler to
   //! prevent duplicate processing.
   //!
   //! \param msg The message to process
   //! \return HANDLED if the message was processed, IGNORED otherwise
   virtual DtVreMessageResult handleMenuMessage(makVre::DtVreMessage* msg);
 
protected:
   //! \brief Flag indicating if this role is stacked on another role
   //!
   //! True if this is a stacked role (typically stacked on a Human role),
   //! false if this is a standalone role. Affects disembarkation behavior.
   bool myIsStackedRole;
};
 
} // namespace makVre