Crystal.AiCollection Class Reference

An AiCollection is a container of all AI building blocks necessary for the construction of utility AI instances. More...

Inheritance diagram for Crystal.AiCollection:

Classes
class	BehaviourCollectionNullException

Public Member Functions
bool	Add (IUtilityAi ai)
	Adds the specified AI. More...
bool	Contains (string aiId)
	Determines whether [contains] [the specified name identifier]. More...
IUtilityAi	GetAi (string aiId)
	Gets the AI. More...
IUtilityAi	Create (string aiId)
	Creates a new utility AI instance if the requested AI named aiId exists within the AiCollection, otherwise this returns null. More...
void	Clear ()
	Removes all AIs in this collection. More...
void	ClearAll ()
	Clears everything, i.e. all actions, considerations, options, behaviours and AIs. More...
	AiCollection (IBehaviourCollection behaviourCollection)
	Initializes a new instance of the AiCollection class. More...

Properties
IBehaviourCollection	Behaviours [get]
	All behaviours available to this AiCollection. More...
IOptionCollection	Options [get]
	All options available to this AiCollection. More...
IConsiderationCollection	Considerations [get]
	All considerations available to this AiCollection. More...
IActionCollection	Actions [get]
	All actions available to this AiCollection. More...
Properties inherited from Crystal.IAiCollection
IBehaviourCollection	Behaviours [get]
	All behaviours available to this AiCollection. More...
IOptionCollection	Options [get]
	All options available to this AiCollection. More...
IConsiderationCollection	Considerations [get]
	All considerations available to this AiCollection. More...
IActionCollection	Actions [get]
	All actions available to this AiCollection. More...

Detailed Description

An AiCollection is a container of all AI building blocks necessary for the construction of utility AI instances.

See also

T:Crystal.IAiCollection

Constructor & Destructor Documentation

Crystal.AiCollection.AiCollection ( IBehaviourCollection  behaviourCollection )

inline

Initializes a new instance of the AiCollection class.

Parameters

behaviourCollection

The behaviour collection.

Exceptions

Crystal.AiCollection.BehaviourCollectionNullException

Member Function Documentation

bool Crystal.AiCollection.Add ( IUtilityAi  ai )

inline

Adds the specified AI.

Parameters

ai

The AI.

Returns

Implements Crystal.IAiCollection.

void Crystal.AiCollection.Clear ( )

inline

Removes all AIs in this collection.

Implements Crystal.IAiCollection.

void Crystal.AiCollection.ClearAll ( )

inline

Clears everything, i.e. all actions, considerations, options, behaviours and AIs.

Implements Crystal.IAiCollection.

bool Crystal.AiCollection.Contains ( string  aiId )

inline

Determines whether [contains] [the specified name identifier].

Parameters

aiId	The name identifier.

Returns

true if [contains] [the specified name identifier]; otherwise, false.

Implements Crystal.IAiCollection.

IUtilityAi Crystal.AiCollection.Create ( string  aiId )

inline

Creates a new utility AI instance if the requested AI named aiId exists within the AiCollection, otherwise this returns null.

Parameters

aiId

Returns

Implements Crystal.IAiCollection.

IUtilityAi Crystal.AiCollection.GetAi ( string  aiId )

inline

Gets the AI.

Parameters

aiId	The name identifier.

Returns

Implements Crystal.IAiCollection.

Property Documentation

IActionCollection Crystal.AiCollection.Actions

get

All actions available to this AiCollection.

IBehaviourCollection Crystal.AiCollection.Behaviours

get

All behaviours available to this AiCollection.

IConsiderationCollection Crystal.AiCollection.Considerations

get

All considerations available to this AiCollection.

IOptionCollection Crystal.AiCollection.Options

get

All options available to this AiCollection.

---

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

• Source/Actors/AiCollection.cs