Action

Core Action model in Agent system. An individual action step used in an Agent Not intended for direct use by application code. User applications should use the annotation programming model with @Agentic and @Action or the Kotlin DSL, or a non-code representation such as YML.

Inheritors

Properties

Link copied to clipboard
abstract val canRerun: Boolean

Can this action be run again if it has already run? Must be set to true to allow looping style behavior.

Link copied to clipboard
open override val cost: <Error class: unknown class>

Cost of performing this action Must be between 0 and 1 1 is the most expensive imaginable.

Link copied to clipboard
open override val domainTypes: Collection<DomainType>

All known types referenced by this component. These may or may not be backed by JVM objects.

Link copied to clipboard
Link copied to clipboard
abstract val effects: EffectSpec

Expected effects of this action. World state should be checked afterward as these effects may not have been achieved

Link copied to clipboard
abstract val inputs: Set<IoBinding>

Data inputs to this step. Will be used to build preconditions, in addition to explicit preconditions.

Link copied to clipboard
Link copied to clipboard
abstract val knownConditions: Set<String>

The names of all conditions that are referenced by this step

Link copied to clipboard
abstract val name: String

Unique name of the step

Link copied to clipboard
abstract val outputs: Set<IoBinding>

Expected data outputs of the step.

Link copied to clipboard

Conditions that must be true for this step to execute

Link copied to clipboard
abstract val qos: ActionQos

Quality of Service for this action.

Link copied to clipboard

Tool groups exposed. This will include directly registered tool groups and tool groups resolved from ToolGroups.

Link copied to clipboard
abstract val value: <Error class: unknown class>

Value of completing this step. From 0 (least valuable) to 1 (most valuable) Steps with 0 value will still be planned if necessary to achieve a result

Functions

Link copied to clipboard
abstract fun execute(processContext: ProcessContext): ActionStatus

Execute an action

Link copied to clipboard
open override fun infoString(verbose: Boolean?, indent: Int): String
Link copied to clipboard
open fun isAchievable(currentState: GoapWorldState): Boolean

Whether the step is available in the current world state

Link copied to clipboard
abstract fun referencedInputProperties(variable: String): Set<String>

Properties referenced from input variable Say "person" is passed. Return "name" and other references

Link copied to clipboard
open fun shortName(): String