ezEngine  Release 25.03
ezEventMsgSetPowerInput Class Reference

This event is posted by ezPowerConnectorComponent whenever the power input on a connector changes. More...

#include <PowerConnectorComponent.h>

Inheritance diagram for ezEventMsgSetPowerInput:

Additional Inherited Members

- Public Member Functions inherited from ezEventMessage
 EZ_DECLARE_MESSAGE_TYPE (ezEventMessage, ezMessage)
 
EZ_ALWAYS_INLINE void FillFromSenderComponent (const ezComponent *pSenderComponent)
 
- Public Member Functions inherited from ezMessage
virtual ezInt32 GetSortingKey () const
 Derived message types can override this method to influence sorting order. Smaller keys are processed first.
 
EZ_ALWAYS_INLINE ezMessageId GetId () const
 Returns the id for this message type.
 
EZ_ALWAYS_INLINE ezUInt16 GetSize () const
 Returns the size in byte of this message.
 
EZ_ALWAYS_INLINE ezUInt64 GetHash () const
 Calculates a hash of the message.
 
virtual void Serialize (ezStreamWriter &inout_stream) const
 Implement this for efficient transmission across process boundaries (e.g. network transfer etc.) More...
 
virtual void Deserialize (ezStreamReader &inout_stream, ezUInt8 uiTypeVersion)
 
- Public Member Functions inherited from ezReflectedClass
virtual const ezRTTIGetDynamicRTTI () const
 
bool IsInstanceOf (const ezRTTI *pType) const
 Returns whether the type of this instance is of the given type or derived from it.
 
template<typename T >
EZ_ALWAYS_INLINE bool IsInstanceOf () const
 Returns whether the type of this instance is of the given type or derived from it.
 
- Static Public Member Functions inherited from ezMessage
static void PackageForTransfer (const ezMessage &msg, ezStreamWriter &inout_stream)
 Writes msg to stream in such a way that ReplicatePackedMessage() can restore it even in another process. More...
 
static ezUniquePtr< ezMessageReplicatePackedMessage (ezStreamReader &inout_stream)
 Restores a message that was written by PackageForTransfer() More...
 
- Static Public Member Functions inherited from ezNoBase
static const ezRTTIGetStaticRTTI ()
 
- Public Attributes inherited from ezEventMessage
ezGameObjectHandle m_hSenderObject
 
ezComponentHandle m_hSenderComponent
 
- Protected Member Functions inherited from ezMessage
 ezMessage (size_t messageSize)
 
- Static Protected Member Functions inherited from ezMessage
static EZ_ALWAYS_INLINE ezMessageId GetNextMsgId ()
 
- Protected Attributes inherited from ezMessage
ezMessageId m_Id
 
ezUInt16 m_uiSize
 
- Static Protected Attributes inherited from ezMessage
static ezMessageId s_NextMsgId = 0
 

Detailed Description

This event is posted by ezPowerConnectorComponent whenever the power input on a connector changes.

When a connector gets input through it's connection to another connector, this message is sent. This can then be used by scripts on parent nodes to switch other functionality on or off. Both the previous and new value are sent, so that the difference can be calculated. This is useful in case a script has multiple connectors and needs to keep track of the total amount of power available.


The documentation for this class was generated from the following file: