Checks whether the AI is in any or in a particular group. More...

#include <IsInGroup.h>

Inheritance diagram for ai::IsInGroup:

Collaboration diagram for ai::IsInGroup:

Public Member Functions
	IsInGroup (const std::string &parameters)

bool	evaluate (const AIPtr &entity) override
	Checks whether the condition evaluates to `true` for the given `entity`. More...

Public Member Functions inherited from ai::ICondition
	ICondition (const std::string &name, const std::string &parameters)

const std::string &	getName () const
	Returns the short name of the condition - without any related conditions or results.

const std::string &	getParameters () const
	Returns the raw parameters of the condition.

std::string	getNameWithConditions (const AIPtr &entity)
	Returns the full condition string with all related conditions and results of the evaluation method. More...

Public Member Functions inherited from ai::_MemObject< AllocatorClass >
void *	operator new (size_t size)

void *	operator new (size_t, void *ptr)

void *	operator new[] (size_t size)

void	operator delete (void *ptr)

void	operator delete (void ptr, void )

void	operator delete[] (void *ptr)

Additional Inherited Members
Protected Member Functions inherited from ai::ICondition
virtual void	getConditionNameWithValue (std::stringstream &s, const AIPtr &entity)
	Override this method to get a more detailed result in `getNameWithConditions()` More...

Static Protected Member Functions inherited from ai::ICondition
static int	getNextId ()

Protected Attributes inherited from ai::ICondition
int	_id
	Every node has an id to identify it. It's unique per type.

const std::string	_name

const std::string	_parameters

Detailed Description

Checks whether the AI is in any or in a particular group.

If a group id is specified in the parameters, this condition only evaluates to true if the AI is part of that particular group. If no parameter is specified, it will evaluate to true if the AI is in any group (even if the group does not contains any other member).

Member Function Documentation

bool ai::IsInGroup::evaluate ( const AIPtr & entity )

inlineoverridevirtual

Checks whether the condition evaluates to true for the given entity.

Parameters

[in,out] entity The entity that is used to evaluate the condition

Returns: true if the condition is fulfilled, false otherwise.

Implements ai::ICondition.

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

/home/travis/build/mgerhardy/simpleai/src/ai/conditions/IsInGroup.h

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation