Make an actor follow a target entity in the world. More...

Public Member Functions
	FollowActor ()
	Constructor.

	~FollowActor () override
	Destructor.

void	Configure (const Entity &_entity, const std::shared_ptr< const sdf::Element > &_sdf, EntityComponentManager &_ecm, EventManager &_eventMgr) final
	Configure the system.

void	PreUpdate (const UpdateInfo &_info, EntityComponentManager &_ecm) final
	Documentation inherited.

Public Member Functions inherited from System
	System ()=default
	Constructor.

virtual	~System ()=default
	Destructor.

Public Member Functions inherited from ISystemConfigure
virtual	~ISystemConfigure ()=default

Public Member Functions inherited from ISystemPreUpdate
virtual	~ISystemPreUpdate ()=default

Additional Inherited Members
Public Types inherited from System
using	PriorityType = int32_t
	Signed integer type used for specifying priority of the execution order of PreUpdate and Update phases.

Static Public Attributes inherited from System
static constexpr PriorityType	kDefaultPriority = {0}
	Default priority value for execution order of the PreUpdate and Update phases.

static constexpr std::string_view	kPriorityElementName
	Name of the XML element from which the priority value will be parsed.

Detailed Description

Make an actor follow a target entity in the world.

System Parameters

<target>: Name of entity to follow.
<min_distance>: Distance in meters to keep from target's origin.
<max_distance>: Distance in meters from target's origin when to stop following. When the actor is back within range it starts following again.
<velocity>: Actor's velocity in m/s
<animation>: Actor's animation to play. If empty, the first animation in the model will be used.
<animation_x_vel>: Velocity of the animation on the X axis. Used to coordinate translational motion with the actor's animation.

FollowActor ( )

explicit

Constructor.

~FollowActor ( )

override

Destructor.

void Configure	(	const Entity &	_entity,
		const std::shared_ptr< const sdf::Element > &	_sdf,
		EntityComponentManager &	_ecm,
		EventManager &	_eventMgr
	)

finalvirtual

Configure the system.

Parameters

[in]	_entity	The entity this plugin is attached to.
[in]	_sdf	The SDF Element associated with this system plugin.
[in]	_ecm	The EntityComponentManager of the given simulation instance.
[in]	_eventMgr	The EventManager of the given simulation instance.