Inheritance diagram for ezTypeScriptComponent:

[legend]

Public Member Functions
void	BroadcastEventMsg (ezEventMessage &ref_msg)

void	SetUpdateInterval (ezTime interval)

void	SetTypeScriptComponentGuid (const ezUuid &resource)

const ezUuid &	GetTypeScriptComponentGuid () const

const ezRangeView< const char *, ezUInt32 >	GetParameters () const

void	SetParameter (const char *szKey, const ezVariant &value)

void	RemoveParameter (const char *szKey)

bool	GetParameter (const char *szKey, ezVariant &out_value) const

Public Member Functions inherited from ezEventMessageHandlerComponent
	ezEventMessageHandlerComponent ()
	Keep the constructor private or protected in derived classes, so it cannot be called manually.

void	SetDebugOutput (bool bEnable)
	Sets the debug output object flag. The effect is type specific, most components will not do anything different.

bool	GetDebugOutput () const
	Gets the debug output object flag.

void	SetGlobalEventHandlerMode (bool bEnable)
	Registers or de-registers this component as a global event handler.

bool	GetGlobalEventHandlerMode () const
	Returns whether this component is registered as a global event handler.

void	SetPassThroughUnhandledEvents (bool bPassThrough)
	Sets whether unhandled event messages should be passed to parent objects or not.

bool	GetPassThroughUnhandledEvents () const

Public Member Functions inherited from ezComponent
void	SetActiveFlag (bool bEnabled)
	Sets the active flag of the component, which affects its active state. More...

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'. More...

bool	IsActive () const
	Checks whether this component is in an active state. More...

bool	IsActiveAndInitialized () const
	Returns whether this component is active and initialized. More...

bool	IsActiveAndSimulating () const
	Whether the component is currently active and simulation has been started as well. More...

ezComponentManagerBase *	GetOwningManager ()
	Returns the corresponding manager for this component.

const ezComponentManagerBase *	GetOwningManager () const
	Returns the corresponding manager for this component.

ezGameObject *	GetOwner ()
	Returns the owner game object if the component is attached to one or nullptr.

const ezGameObject *	GetOwner () const
	Returns the owner game object if the component is attached to one or nullptr.

ezWorld *	GetWorld ()
	Returns the corresponding world for this component.

const ezWorld *	GetWorld () const
	Returns the corresponding world for this component.

ezComponentHandle	GetHandle () const
	Returns a handle to this component.

ezUInt32	GetUniqueID () const
	Returns the unique id for this component.

void	SetUniqueID (ezUInt32 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.

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg)
	Sends a message to this component.

EZ_ALWAYS_INLINE bool	SendMessage (ezMessage &ref_msg) const

void	PostMessage (const ezMessage &msg, ezTime delay=ezTime::MakeZero(), ezObjectMsgQueueType::Enum queueType=ezObjectMsgQueueType::NextFrame) const
	Queues the message for the given phase. The message is processed after the given delay in the corresponding phase.

void	SetUserFlag (ezUInt8 uiFlagIndex, bool bSet)
	Be careful to check which flags may already be in use by base classes.

bool	GetUserFlag (ezUInt8 uiFlagIndex) const
	Retrieves a custom flag. Index must be between 0 and 7.

void	SetCreatedByPrefab ()
	Adds ezObjectFlags::CreatedByPrefab to the component. See the flag for details.

bool	WasCreatedByPrefab () const
	Checks whether the ezObjectFlags::CreatedByPrefab flag is set on this component.

Public Member Functions inherited from ezReflectedClass
virtual const ezRTTI *	GetDynamicRTTI () 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.

Protected Member Functions
virtual void	SerializeComponent (ezWorldWriter &stream) const override
	Override this to save the current state of the component to the given stream.

virtual void	DeserializeComponent (ezWorldReader &stream) override
	Override this to load the current state of the component from the given stream. More...

virtual void	Initialize () override
	Can be overridden for basic initialization that depends on a valid hierarchy and position. More...

virtual void	Deinitialize () override
	This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work. More...

virtual void	OnActivated () override
	This method is called when the component gets activated. More...

virtual void	OnDeactivated () override
	This method is called when the component gets deactivated. More...

virtual void	OnSimulationStarted () override
	This method is called once for active components, at the start of the next world update, but only when the world is simulated. More...

virtual bool	HandlesMessage (const ezMessage &msg) const override
	Returns whether the given Message is handled by this component.

virtual bool	OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) override
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More...

virtual bool	OnUnhandledMessage (ezMessage &msg, bool bWasPostedMsg) const override
	When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler. More...

bool	HandleUnhandledMessage (ezMessage &msg, bool bWasPostedMsg)

Protected Member Functions inherited from ezComponent
	ezComponent ()
	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 ezWorldModuleTypeId	GetTypeId () const =0

virtual ezComponentMode::Enum	GetMode () const =0

void	EnableUnhandledMessageHandler (bool enable)
	By default disabled. Enable to have OnUnhandledMessage() called for every unhandled message.

bool	IsInitialized () const

bool	IsInitializing () const

bool	IsSimulationStarted () const

Additional Inherited Members
Static Public Member Functions inherited from ezEventMessageHandlerComponent
static ezArrayPtr< ezComponentHandle >	GetAllGlobalEventHandler (const ezWorld *pWorld)
	Returns all global event handler for the given world.

static void	ClearGlobalEventHandlersForWorld (const ezWorld *pWorld)

Static Public Member Functions inherited from ezNoBase
static const ezRTTI *	GetStaticRTTI ()

Protected Attributes inherited from ezComponent
const ezRTTI *	m_pMessageDispatchType = nullptr
	Messages will be dispatched to this type. Default is what GetDynamicRTTI() returns, can be redirected if necessary.

Member Function Documentation

◆ Deinitialize()

void ezTypeScriptComponent::Deinitialize ( )

overrideprotectedvirtual

This method is called before the component is destroyed. A derived type can override this method to do common de-initialization work.

This function is always called before destruction, even if the component is currently not active. The default implementation checks whether the component is currently active and will ensure OnDeactivated() gets called if necessary. For typical game code, prefer to use OnDeactivated().

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezEventMessageHandlerComponent.

◆ DeserializeComponent()

void ezTypeScriptComponent::DeserializeComponent ( ezWorldReader & inout_stream )

overrideprotectedvirtual

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 ezEventMessageHandlerComponent.

◆ Initialize()

void ezTypeScriptComponent::Initialize ( )

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 ezGameObject is set. Contrary to OnActivated() and OnSimulationStarted(), this function is always called for all components.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezComponent.

◆ OnActivated()

void ezTypeScriptComponent::OnActivated ( )

overrideprotectedvirtual

This method is called when the component gets activated.

By default a component is active, but it can be created in an inactive state. In such a case OnActivated() is only called once a component is activated. If a component gets switched between active and inactive at runtime, OnActivated() and OnDeactivated() are called accordingly. In contrast Initialize() and Deinitialize() are only ever called once.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezComponent.

◆ OnDeactivated()

void ezTypeScriptComponent::OnDeactivated ( )

overrideprotectedvirtual

This method is called when the component gets deactivated.

Upon destruction, a component that is active first gets deactivated. Therefore OnDeactivated() should be used for typical game code cleanup.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezComponent.

◆ OnSimulationStarted()

void ezTypeScriptComponent::OnSimulationStarted ( )

overrideprotectedvirtual

This method is called once for active components, at the start of the next world update, but only when the world is simulated.

This is the one preferred method to setup typical game logic. In a pure game environment there is no practical difference between OnActivated() and OnSimulationStarted(), as OnSimulationStarted() will be called right after OnActivated().

However, when a scene is open inside the editor, there is an important difference: OnActivated() is called once the component was created. OnSimulationStarted() is only called once the game simulation is started inside the editor. As an example, if a component starts a sound in OnActivated(), that sound will play right after the scene has been loaded into the editor. If instead the sound gets started in OnSimulationStarted(), it will only play once the user starts the game mode inside the editor.

Additionally, OnSimulationStarted() is only executed once, even if the ezWorld pauses and resumes world simulation multiple times. However, note that it will be called again after the component has been deactivated and is activated again.

See also: OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from ezComponent.

◆ OnUnhandledMessage() [1/2]

bool ezTypeScriptComponent::OnUnhandledMessage	(	ezMessage &	msg,
		bool	bWasPostedMsg
	)		const

overrideprotectedvirtual

When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

Returns: Should return true if the given message was handled, false otherwise.

Reimplemented from ezComponent.

◆ OnUnhandledMessage() [2/2]

bool ezTypeScriptComponent::OnUnhandledMessage	(	ezMessage &	msg,
		bool	bWasPostedMsg
	)

overrideprotectedvirtual

When EnableUnhandledMessageHandler() was activated, this is called for all messages for which there is no dedicated message handler.

Returns: Should return true if the given message was handled, false otherwise.

Reimplemented from ezComponent.

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

/home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/TypeScriptPlugin/Components/TypeScriptComponent.h
/home/runner/work/ezEngine/ezEngine/Code/EnginePlugins/TypeScriptPlugin/Components/TypeScriptComponent.cpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Member Function Documentation

◆ Deinitialize()

◆ DeserializeComponent()

◆ Initialize()

◆ OnActivated()

◆ OnDeactivated()

◆ OnSimulationStarted()

◆ OnUnhandledMessage() [1/2]

◆ OnUnhandledMessage() [2/2]