Crystal AI  1.0.0
Crystal.AiConstructor Class Referenceabstract

A convenience class used to streamline the process of creating a utility AI. More...

Classes

class  AiCollectionNullException
 
class  AiConfigurationxception
 

Public Member Functions

IUtilityAi Create (string aiId)
 Creates the AI associated with the given identifier; if such an AI does not exist this returns null. More...
 

Protected Member Functions

void IsOkay (bool expression)
 Determines whether the specified expression is okay. More...
 
abstract void DefineActions ()
 Instantiate all T:Crystal.IActions used in your AI here. Use P:Crystal.AiConstructor.Actions to register the newly instantiated T:Crystal.IActions to the T:Crystal.IActionCollection of this T:Crystal.AiConsturctor. More...
 
abstract void DefineConsiderations ()
 Instantiate all T:Crystal.IConsiderations and T:Crystal.ICompositeConsiderations used in your AI here. Use P:Crystal.AiConstructor.Considerations to register the newly instantiated T:Crystal.IConsiderations (or T:Crystal.ICompositeConsiderations) to the T:Crystal.IConsiderationCollection of this T:Crystal.AiConsturctor. More...
 
abstract void DefineOptions ()
 Instantiate all T:Crystal.IOptions used in your AI here. Use P:Crystal.AiConstructor.Options to register the newly instantiated T:Crystal.IOptions to the T:Crystal.IOptionCollection of this T:Crystal.AiConsturctor. More...
 
abstract void DefineBehaviours ()
 Instantiate all T:Crystal.IBehaviours used in your AI here. Use P:Crystal.AiConstructor.Behaviours to register the newly instantiated T:Crystal.IBehaviours to the T:Crystal.IBehaviourCollection of this T:Crystal.AiConsturctor. More...
 
abstract void ConfigureAi ()
 Instantiate all T:Crystal.IUtilityAIs here. Use P:Crystal.AiConstructor.AIs to register the newly instantiated T:Crystal.IUtilityAIs to the T:Crystal.IAiCollection of this T:Crystal.AiConsturctor. More...
 
 AiConstructor (IAiCollection collection)
 Initializes a new instance of the AiConstructor class. More...
 

Protected Attributes

IAction A
 Convenience variable for T:Crystal.IActions. This should only be used as a temporary variable and nothing more. More...
 
IConsideration C
 Convenience variable for T:Crystal.IConsiderations. This should only be used as a temporary variable and nothing more. More...
 
ICompositeConsideration Cc
 Convenience variable for T:Crystal.ICompositeConsiderations. This should only be used as a temporary variable and nothing more. More...
 
IOption O
 Convenience variable for T:Crystal.IOptions. This should only be used as a temporary variable and nothing more. More...
 
IBehaviour B
 Convenience variable for T:Crystal.IBehaviours. This should only be used as a temporary variable and nothing more. More...
 
IUtilityAi Ai
 Convenience variable for T:Crystal.IUtilityAIs. This should only be used as a temporary variable and nothing more. More...
 

Properties

IActionCollection Actions [get]
 A collection that contains all available T:Crystal.IActions to this instance. More...
 
IConsiderationCollection Considerations [get]
 A collection that contains all available T:Crystal.IConsiderations to this instance. More...
 
IOptionCollection Options [get]
 A collection that contains all available T:Crystal.IOptions to this instance. More...
 
IBehaviourCollection Behaviours [get]
 A collection that contains all available T:Crystal.IBehaviours to this instance. More...
 
IAiCollection AIs [get, protected set]
 A collection that contains all available T:Crystal.IUtilityAis to this instance. More...
 

Detailed Description

A convenience class used to streamline the process of creating a utility AI.

Constructor & Destructor Documentation

Crystal.AiConstructor.AiConstructor ( IAiCollection  collection)
inlineprotected

Initializes a new instance of the AiConstructor class.

Parameters
collectionThe collection.
Exceptions
Crystal.AiConstructor.AiCollectionNullException

Member Function Documentation

abstract void Crystal.AiConstructor.ConfigureAi ( )
protectedpure virtual

Instantiate all T:Crystal.IUtilityAIs here. Use P:Crystal.AiConstructor.AIs to register the newly instantiated T:Crystal.IUtilityAIs to the T:Crystal.IAiCollection of this T:Crystal.AiConsturctor.

IUtilityAi Crystal.AiConstructor.Create ( string  aiId)
inline

Creates the AI associated with the given identifier; if such an AI does not exist this returns null.

Parameters
aiIdThe AI identifier.
abstract void Crystal.AiConstructor.DefineActions ( )
protectedpure virtual

Instantiate all T:Crystal.IActions used in your AI here. Use P:Crystal.AiConstructor.Actions to register the newly instantiated T:Crystal.IActions to the T:Crystal.IActionCollection of this T:Crystal.AiConsturctor.

abstract void Crystal.AiConstructor.DefineBehaviours ( )
protectedpure virtual

Instantiate all T:Crystal.IBehaviours used in your AI here. Use P:Crystal.AiConstructor.Behaviours to register the newly instantiated T:Crystal.IBehaviours to the T:Crystal.IBehaviourCollection of this T:Crystal.AiConsturctor.

abstract void Crystal.AiConstructor.DefineConsiderations ( )
protectedpure virtual

Instantiate all T:Crystal.IConsiderations and T:Crystal.ICompositeConsiderations used in your AI here. Use P:Crystal.AiConstructor.Considerations to register the newly instantiated T:Crystal.IConsiderations (or T:Crystal.ICompositeConsiderations) to the T:Crystal.IConsiderationCollection of this T:Crystal.AiConsturctor.

abstract void Crystal.AiConstructor.DefineOptions ( )
protectedpure virtual

Instantiate all T:Crystal.IOptions used in your AI here. Use P:Crystal.AiConstructor.Options to register the newly instantiated T:Crystal.IOptions to the T:Crystal.IOptionCollection of this T:Crystal.AiConsturctor.

void Crystal.AiConstructor.IsOkay ( bool  expression)
inlineprotected

Determines whether the specified expression is okay.

Parameters
expressionif set to true [expression].
Exceptions
AiConfigurationxception

Member Data Documentation

IAction Crystal.AiConstructor.A
protected

Convenience variable for T:Crystal.IActions. This should only be used as a temporary variable and nothing more.

IUtilityAi Crystal.AiConstructor.Ai
protected

Convenience variable for T:Crystal.IUtilityAIs. This should only be used as a temporary variable and nothing more.

IBehaviour Crystal.AiConstructor.B
protected

Convenience variable for T:Crystal.IBehaviours. This should only be used as a temporary variable and nothing more.

IConsideration Crystal.AiConstructor.C
protected

Convenience variable for T:Crystal.IConsiderations. This should only be used as a temporary variable and nothing more.

ICompositeConsideration Crystal.AiConstructor.Cc
protected

Convenience variable for T:Crystal.ICompositeConsiderations. This should only be used as a temporary variable and nothing more.

IOption Crystal.AiConstructor.O
protected

Convenience variable for T:Crystal.IOptions. This should only be used as a temporary variable and nothing more.

Property Documentation

IActionCollection Crystal.AiConstructor.Actions
get

A collection that contains all available T:Crystal.IActions to this instance.

IAiCollection Crystal.AiConstructor.AIs
getprotected set

A collection that contains all available T:Crystal.IUtilityAis to this instance.

IBehaviourCollection Crystal.AiConstructor.Behaviours
get

A collection that contains all available T:Crystal.IBehaviours to this instance.

IConsiderationCollection Crystal.AiConstructor.Considerations
get

A collection that contains all available T:Crystal.IConsiderations to this instance.

IOptionCollection Crystal.AiConstructor.Options
get

A collection that contains all available T:Crystal.IOptions to this instance.


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