Class GoapAction

Inheritance
System.Object
GoapAction
AllGoalsSatisfiedAction
NoGoalReachableAction
Implements
Namespace: Mars.Components.Services.Planning
Assembly: Mars.Components.dll
Syntax
public abstract class GoapAction : object, IGoapAction

Constructors

GoapAction(IGoapAgentStates, Single)

Declaration
protected GoapAction(IGoapAgentStates agentStates, float cost = null)
Parameters
Type Name Description
IGoapAgentStates agentStates
System.Single cost

Properties

Cost

Declaration
public float Cost { get; protected set; }
Property Value
Type Description
System.Single

Effects

Declaration
public IDictionary<IGoapStateKey, GoapStateProperty> Effects { get; }
Property Value
Type Description
IDictionary<IGoapStateKey, GoapStateProperty>

Preconditions

Declaration
public IDictionary<IGoapStateKey, GoapStateProperty> Preconditions { get; }
Property Value
Type Description
IDictionary<IGoapStateKey, GoapStateProperty>

Methods

AddOrUpdateEffect(GoapStateProperty)

Declaration
public void AddOrUpdateEffect(GoapStateProperty effect)
Parameters
Type Name Description
GoapStateProperty effect

AddOrUpdateEffect<T>(KeyValuePair<GoapStateKey<T>, T>)

Adds an effect to this action or updates an existing effect with the same key.
Declaration
public void AddOrUpdateEffect<T>(KeyValuePair<GoapStateKey<T>, T> kvp)
Parameters
Type Name Description
KeyValuePair<GoapStateKey<T>, T> kvp Identifies the state property.
Type Parameters
Name Description
T The type of value.

AddOrUpdateEffect<T>(GoapStateKey<T>, T)

Adds an effect to this action or updates an existing effect with the same key.
Declaration
public void AddOrUpdateEffect<T>(GoapStateKey<T> key, T value)
Parameters
Type Name Description
GoapStateKey<T> key Identifies the state property.
T value The specific manifestation of this state.
Type Parameters
Name Description
T The type of value.

AddOrUpdatePrecondition(GoapStateProperty)

Declaration
public void AddOrUpdatePrecondition(GoapStateProperty precondition)
Parameters
Type Name Description
GoapStateProperty precondition

AddOrUpdatePrecondition<T>(KeyValuePair<GoapStateKey<T>, T>)

Adds a precondition to this action or updates an existing precondition with the same key.
Declaration
public void AddOrUpdatePrecondition<T>(KeyValuePair<GoapStateKey<T>, T> kvp)
Parameters
Type Name Description
KeyValuePair<GoapStateKey<T>, T> kvp Identifies the state property.
Type Parameters
Name Description
T The type of value.

AddOrUpdatePrecondition<T>(GoapStateKey<T>, T)

Adds a precondition to this action or updates an existing precondition with the same key.
Declaration
public void AddOrUpdatePrecondition<T>(GoapStateKey<T> key, T value)
Parameters
Type Name Description
GoapStateKey<T> key Identifies the state property.
T value The specific manifestation of this state.
Type Parameters
Name Description
T The type of value.

Execute()

Declaration
public bool Execute()
Returns
Type Description
System.Boolean

ExecuteAction()

Simply executes the specific action code, without GOAP overhead organization.
Declaration
protected abstract bool ExecuteAction()
Returns
Type Description
System.Boolean True, if the action instructions were successful, false otherwise

RemoveEffect(GoapStateProperty)

Declaration
public void RemoveEffect(GoapStateProperty effect)
Parameters
Type Name Description
GoapStateProperty effect

RemoveEffect(IGoapStateKey)

Removes an effect with given key.
Declaration
public void RemoveEffect(IGoapStateKey effectKey)
Parameters
Type Name Description
IGoapStateKey effectKey Identifies the effect that should be removed.

RemovePrecondition(GoapStateProperty)

Declaration
public void RemovePrecondition(GoapStateProperty precondition)
Parameters
Type Name Description
GoapStateProperty precondition

RemovePrecondition(IGoapStateKey)

Removes a precondition with given key.
Declaration
public void RemovePrecondition(IGoapStateKey preconditionKey)
Parameters
Type Name Description
IGoapStateKey preconditionKey Identifies the precondition that should be removed.

UpdateCost()

Declaration
public virtual void UpdateCost()

Implements