io.sarl.api.game.tgob
Interface Goal
All Known Implementing Classes:
BaseGoal
@org.eclipse.xtext.xbase.lib.XbaseGenerated
interface Goal
Describes a goal in the game time-based goal-oriented behavior.
Maven Group Identifier:
io.sarl.sdk
Maven Artifact Identifier:
api.gametgob
Since:
0.13
Property Summary
Modifier and type Property and description
double insistence
Replies the insistence value that is associated to the goal.
double insistenceChangePerTimeUnit
Replies the change to apply to the insistence of this goal when the time progress about one unit.
java.lang.String name
Replies the name of the goal.
Action Summary
Modifier and type Action and description
default double getDiscontentmentFor(double)
Replies the discontenment value that corresponds to the given insistence value.
abstract double getInsistence
Replies the insistence value that is associated to the goal.
default double getInsistenceChangePerTimeUnit
Replies the change to apply to the insistence of this goal when the time progress about one unit.
abstract java.lang.String getName
Replies the name of the goal.
abstract void setInsistence(double)
Change the insistence value that is associated to the goal.
Property Details
insistence 
var insistence : double
Replies the insistence value that is associated to the goal.

This property is an alias for the action: getInsistence

Returns:
the positive value of the insistence.
insistenceChangePerTimeUnit 
val insistenceChangePerTimeUnit : double
Replies the change to apply to the insistence of this goal when the time progress about one unit.

This property is an alias for the action: getInsistenceChangePerTimeUnit

Returns:
the insistence progress for a time unit.
name 
val name : java.lang.String
Replies the name of the goal.

This property is an alias for the action: getName

Returns:
the name.
Action Details
getDiscontentmentFor(double) 
def getDiscontentmentFor(double) : double
Replies the discontenment value that corresponds to the given insistence value. By default, the discontenment value is equal to the square of the insistence.
Parameters:
insistence - the insistence value for which the discontenement must be computed.
Returns:
the discontenement value.
getInsistence 
def getInsistence : double
Replies the insistence value that is associated to the goal.
Returns:
the positive value of the insistence.
getInsistenceChangePerTimeUnit 
def getInsistenceChangePerTimeUnit : double
Replies the change to apply to the insistence of this goal when the time progress about one unit.
Returns:
the insistence progress for a time unit.
getName 
def getName : java.lang.String
Replies the name of the goal.
Returns:
the name.
setInsistence(double) 
def setInsistence(double)
Change the insistence value that is associated to the goal.
Parameters:
newInsistence - the positive value of the insistence.