 |
Plasma Engine
2.0
|
|
Plasma Engine
2.0
|
Handles plMsgTriggerTriggered events and sends new messages after a delay. More...
#include <TriggerDelayModifierComponent.h>
Public Member Functions | |
| virtual void | SerializeComponent (plWorldWriter &inout_stream) const override |
| Override this to save the current state of the component to the given stream. | |
| virtual void | DeserializeComponent (plWorldReader &inout_stream) override |
| Override this to load the current state of the component from the given stream. | |
 Public Member Functions inherited from plComponent | |
| void | SetActiveFlag (bool bEnabled) |
| Sets the active flag of the component, which affects its active state. | |
| bool | GetActiveFlag () const |
| Checks whether the 'active flag' is set on this component. Note that this does not mean that the component is also 'active'. | |
| bool | IsActive () const |
| Checks whether this component is in an active state. | |
| bool | IsActiveAndInitialized () const |
| Returns whether this component is active and initialized. | |
| bool | IsActiveAndSimulating () const |
| Whether the component is currently active and simulation has been started as well. | |
| plComponentManagerBase * | GetOwningManager () |
| Returns the corresponding manager for this component. | |
| const plComponentManagerBase * | GetOwningManager () const |
| Returns the corresponding manager for this component. | |
| plGameObject * | GetOwner () |
| Returns the owner game object if the component is attached to one or nullptr. | |
| const plGameObject * | GetOwner () const |
| Returns the owner game object if the component is attached to one or nullptr. | |
| plWorld * | GetWorld () |
| Returns the corresponding world for this component. | |
| const plWorld * | GetWorld () const |
| Returns the corresponding world for this component. | |
| plComponentHandle | GetHandle () const |
| Returns a handle to this component. | |
| plUInt32 | GetUniqueID () const |
| Returns the unique id for this component. | |
| void | SetUniqueID (plUInt32 uiUniqueID) |
| Sets the unique id for this component. | |
| void | EnsureInitialized () |
| Ensures that the component is initialized. Must only be called from another component's Initialize callback. | |
| void | EnsureSimulationStarted () |
| Ensures that the OnSimulationStarted method has been called. Must only be called from another component's OnSimulationStarted callback. | |
| PL_ALWAYS_INLINE bool | SendMessage (plMessage &ref_msg) |
| Sends a message to this component. | |
| PL_ALWAYS_INLINE bool | SendMessage (plMessage &ref_msg) const |
| void | PostMessage (const plMessage &msg, plTime delay=plTime::MakeZero(), plObjectMsgQueueType::Enum queueType=plObjectMsgQueueType::NextFrame) const |
| Queues the message for the given phase. The message is processed after the given delay in the corresponding phase. | |
| virtual bool | HandlesMessage (const plMessage &msg) const |
| Returns whether the given Message is handled by this component. | |
| void | SetUserFlag (plUInt8 uiFlagIndex, bool bSet) |
| Be careful to check which flags may already be in use by base classes. | |
| bool | GetUserFlag (plUInt8 uiFlagIndex) const |
| Retrieves a custom flag. Index must be between 0 and 7. | |
| void | SetCreatedByPrefab () |
| Adds plObjectFlags::CreatedByPrefab to the component. See the flag for details. | |
| bool | WasCreatedByPrefab () const |
| Checks whether the plObjectFlags::CreatedByPrefab flag is set on this component. | |
| Public Member Functions inherited from plReflectedClass | |
| virtual const plRTTI * | GetDynamicRTTI () const |
| bool | IsInstanceOf (const plRTTI *pType) const |
| Returns whether the type of this instance is of the given type or derived from it. | |
| template<typename T > | |
| PL_ALWAYS_INLINE bool | IsInstanceOf () const |
| Returns whether the type of this instance is of the given type or derived from it. | |
Protected Member Functions | |
| virtual void | Initialize () override |
| Can be overridden for basic initialization that depends on a valid hierarchy and position. | |
| void | OnMsgTriggerTriggered (plMsgTriggerTriggered &msg) |
| void | OnMsgComponentInternalTrigger (plMsgComponentInternalTrigger &msg) |
| Protected Member Functions inherited from plComponent | |
| plComponent () | |
| Keep the constructor private or protected in derived classes, so it cannot be called manually. | |
| bool | IsDynamic () const |
| Returns whether this component is dynamic and thus can only be attached to dynamic game objects. | |
| virtual plWorldModuleTypeId | GetTypeId () const =0 |
| virtual plComponentMode::Enum | GetMode () const =0 |
| virtual void | Deinitialize () |
| This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. | |
| virtual void | OnActivated () |
| This method is called when the component gets activated. | |
| virtual void | OnDeactivated () |
| This method is called when the component gets deactivated. | |
| virtual void | OnSimulationStarted () |
| This method is called once for active components, at the start of the next world update, but only when the world is simulated. | |
| void | EnableUnhandledMessageHandler (bool enable) |
| By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message. | |
| virtual bool | OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. | |
| virtual bool | OnUnhandledMessage (plMessage &msg, bool bWasPostedMsg) const |
| When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. | |
| bool | IsInitialized () const |
| bool | IsInitializing () const |
| bool | IsSimulationStarted () const |
Protected Attributes | |
| bool | m_bIsActivated = false |
| plInt32 | m_iElementsInside = 0 |
| plInt32 | m_iValidActivationToken = 0 |
| plInt32 | m_iValidDeactivationToken = 0 |
| plTime | m_ActivationDelay |
| plTime | m_DeactivationDelay |
| plHashedString | m_sMessage |
| plEventMessageSender< plMsgTriggerTriggered > | m_TriggerEventSender |
| Protected Attributes inherited from plComponent | |
| const plRTTI * | m_pMessageDispatchType = nullptr |
| Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary. | |
Additional Inherited Members | |
| Static Public Member Functions inherited from plNoBase | |
| static const plRTTI * | GetStaticRTTI () |
Handles plMsgTriggerTriggered events and sends new messages after a delay.
The 'enter' and 'leave' messages are sent only when an empty trigger is entered or when the last object leaves the trigger. While any object is already inside the trigger, no change event is sent. Therefore this component can't be used to keep track of all the objects inside the trigger.
The 'enter' and 'leave' events can be sent with a delay. The 'enter' event is only sent, if the trigger had at least one object inside it for the full duration of the delay. Which exact object may change, but once the trigger contains no object, the timer is reset.
The sent plMsgTriggerTriggered does not contain a reference to the 'triggering' object, since there may be multiple and they may change randomly.
|
overridevirtual |
Override this to load the current state of the component from the given stream.
The active state will be automatically serialized. The 'initialized' state is not serialized, all components will be initialized after creation, even if they were already in an initialized state when they were serialized.
Reimplemented from plComponent.
|
overrideprotectedvirtual |
Can be overridden for basic initialization that depends on a valid hierarchy and position.
All trivial initialization should be done in the constructor. For typical game code, you should prefer to use OnSimulationStarted(). This method is called once for every component, after creation but only at the start of the next world update. Therefore the global position has already been computed and the owner plGameObject is set. Contrary to OnActivated() and OnSimulationStarted(), this function is always called for all components.
Reimplemented from plComponent.
|
overridevirtual |
Override this to save the current state of the component to the given stream.
Reimplemented from plComponent.
1.11.0