Crystal.IAiCollection Interface Reference

Interface for AiCollections. AiCollections contain the building blocks for spawning concrete AI instances. An AiCollection also contains all sub-collections used in its composition. More...

Inheritance diagram for Crystal.IAiCollection:

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)
	Returns the AI associated with the given identifier, or null if no such AI exists within the collection. More...
void	Clear ()
	Removes all AIs in this collection. More...
void	ClearAll ()
	Clears everything, i.e. all actions, considerations, options, behaviours and AIs. 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...

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...

Detailed Description

Interface for AiCollections. AiCollections contain the building blocks for spawning concrete AI instances. An AiCollection also contains all sub-collections used in its composition.

Member Function Documentation

bool Crystal.IAiCollection.Add

(

IUtilityAi

ai

)

Adds the specified AI.

Parameters

ai

The ai.

Returns

Returns true if the AI was successfully added false otherwise.

Implemented in Crystal.AiCollection.

void Crystal.IAiCollection.Clear

(

)

Removes all AIs in this collection.

Implemented in Crystal.AiCollection.

void Crystal.IAiCollection.ClearAll

(

)

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

Implemented in Crystal.AiCollection.

bool Crystal.IAiCollection.Contains

(

string

aiId

)

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

Parameters

aiId	The name identifier.

Returns

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

Implemented in Crystal.AiCollection.

IUtilityAi Crystal.IAiCollection.Create

(

string

aiId

)

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

Parameters

aiId

Returns

Implemented in Crystal.AiCollection.

IUtilityAi Crystal.IAiCollection.GetAi

(

string

aiId

)

Returns the AI associated with the given identifier, or null if no such AI exists within the collection.

Parameters

aiId	The AI identifier.

Returns

Implemented in Crystal.AiCollection.

Property Documentation

IActionCollection Crystal.IAiCollection.Actions

get

All actions available to this AiCollection.

IBehaviourCollection Crystal.IAiCollection.Behaviours

get

All behaviours available to this AiCollection.

IConsiderationCollection Crystal.IAiCollection.Considerations

get

All considerations available to this AiCollection.

IOptionCollection Crystal.IAiCollection.Options

get

All options available to this AiCollection.

---

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

• Source/Actors/Interfaces/IAICollection.cs