RosettaStone::SimpleTasks::IncludeTask Class Reference

IncludeTask class. More...

#include <Rosetta/Tasks/SimpleTasks/IncludeTask.hpp>

Inheritance diagram for RosettaStone::SimpleTasks::IncludeTask:
RosettaStone::ITask

Public Member Functions

 IncludeTask ()=default
 Default constructor. More...
 
TaskID GetTaskID () const override
 
- Public Member Functions inherited from RosettaStone::ITask
 ITask ()=default
 Default constructor. More...
 
 ITask (EntityType entityType)
 
 ITask (Entity *source, Entity *target)
 
 ITask (EntityType entityType, Entity *source, Entity *target)
 
virtual ~ITask ()=default
 Default destructor. More...
 
 ITask (const ITask &task)=default
 Default copy constructor. More...
 
 ITask (ITask &&task)=default
 Default move constructor. More...
 
ITaskoperator= (const ITask &task)=default
 Default copy assignment operator. More...
 
ITaskoperator= (ITask &&task)=default
 Default move assignment operator. More...
 
EntityType GetEntityType () const
 
void SetSource (Entity *source)
 
void SetTarget (Entity *target)
 
TaskStatus Run (Player &player)
 

Static Public Member Functions

static std::vector< Entity * > GetEntities (EntityType entityType, Player &player, Entity *source=nullptr, Entity *target=nullptr)
 

Additional Inherited Members

- Static Public Attributes inherited from RosettaStone::ITask
template<typename T >
static constexpr bool isTask
 
- Protected Attributes inherited from RosettaStone::ITask
EntityType m_entityType = EntityType::EMPTY
 
Entitym_source = nullptr
 
Entitym_target = nullptr
 

Detailed Description

IncludeTask class.

This class represents the task for including entities to be applied by another task.

Constructor & Destructor Documentation

◆ IncludeTask()

RosettaStone::SimpleTasks::IncludeTask::IncludeTask ( )
default

Default constructor.

Member Function Documentation

◆ GetEntities()

static std::vector<Entity*> RosettaStone::SimpleTasks::IncludeTask::GetEntities ( EntityType  entityType,
Player player,
Entity source = nullptr,
Entity target = nullptr 
)
static

Returns a list of entities based on the type of entity.

Parameters
entityTypeThe type of entity.
playerThe player to get hand or battlefield.
sourceThe source that indicates source entity.
targetThe target that indicates target entity.
Returns
A list of entities based on the type of entity.

◆ GetTaskID()

TaskID RosettaStone::SimpleTasks::IncludeTask::GetTaskID ( ) const
overridevirtual

Returns task ID.

Returns
Task ID.

Implements RosettaStone::ITask.


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