plSpawnBoxComponent Class Reference

This component spawns prefabs inside a box. More...

#include <SpawnBoxComponent.h>

Inheritance diagram for plSpawnBoxComponent:

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.
void	StartSpawning ()
	When called, the component starts spawning the chosen number of prefabs over the set duration.
void	SetHalfExtents (const plVec3 &value)
const plVec3 &	GetHalfExtents () const
void	SetPrefabFile (const char *szFile)
const char *	GetPrefabFile () const
bool	GetSpawnAtStart () const
void	SetSpawnAtStart (bool b)
bool	GetSpawnContinuously () const
void	SetSpawnContinuously (bool b)
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.

Public Attributes
plTime	m_SpawnDuration
plUInt16	m_uiMinSpawnCount = 5
plUInt16	m_uiSpawnCountRange = 5
plPrefabResourceHandle	m_hPrefab
plAngle	m_MaxRotationZ
	The spawned object's forward direction may deviate this amount from the spawn box's forward rotation. This is accomplished by rotating around the Z axis.
plAngle	m_MaxTiltZ
	The spawned object's Z (up) axis may deviate by this amount from the spawn box's Z axis.

Protected Member Functions
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.
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	Initialize ()
	Can be overridden for basic initialization that depends on a valid hierarchy and position.
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.
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

Additional Inherited Members
Static Public Member Functions inherited from plNoBase
static const plRTTI *	GetStaticRTTI ()
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.

Detailed Description

This component spawns prefabs inside a box.

The prefabs are spawned over a fixed duration. The number of prefabs to spawn over the time duration is randomly chosen. Each prefab may get rotated around the Z axis and tilted away from the Z axis. If desired, the component can start spawning automatically, or it can be (re-)started from code. If 'spawn continuously' is enabled, the component restarts itself after the spawn duration is over, thus for every spawn duration the number of prefabs to spawn gets reevaluated.

Member Function Documentation

DeserializeComponent()

void plSpawnBoxComponent::DeserializeComponent ( plWorldReader & inout_stream )

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.

OnSimulationStarted()

void plSpawnBoxComponent::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 ever executed once on a component, even if the plWorld pauses and resumes world simulation multiple times. Thus components that should only execute a thing exactly once, will work correctly. In contrast OnActivated() and OnDeactivated() will be executed every time the component's active state is toggled, which could re-execute the same behavior multiple times.

See also

OnActivated(), OnDeactivated(), Initialize(), Deinitialize(), OnSimulationStarted()

Reimplemented from plComponent.

SerializeComponent()

void plSpawnBoxComponent::SerializeComponent ( plWorldWriter & inout_stream ) const

overridevirtual

Override this to save the current state of the component to the given stream.

Reimplemented from plComponent.

StartSpawning()

void plSpawnBoxComponent::StartSpawning

(

)

When called, the component starts spawning the chosen number of prefabs over the set duration.

If this is called while the component is already active, the internal state is reset and it starts over.

---

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

• Code/Engine/GameEngine/Gameplay/SpawnBoxComponent.h
• Code/Engine/GameEngine/Gameplay/Implementation/SpawnBoxComponent.cpp