IHunterPreyEnvironmentService (jadex-applications-micro 2.1 API)

All Known Implementing Classes:

HunterPreyEnvironmentService
```
public interface IHunterPreyEnvironmentService
```
Service-based interface to hunter-prey environment.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`DIRECTION_DOWN` The move direction down.
`static String`	`DIRECTION_LEFT` The move direction left.
`static String`	`DIRECTION_NONE` Placeholder for "no move" action.
`static String`	`DIRECTION_RIGHT` The move direction right.
`static String`	`DIRECTION_UP` The move direction up.

Method Summary

Methods
Modifier and Type	Method and Description
`IFuture<Void>`	`eat(IFood food)` Perform an eat action for the avatar of the calling component.
`IFuture<Void>`	`move(String direction)` Perform a move action for the avatar of the calling component.
`ISubscriptionIntermediateFuture<Collection<IPreyPerceivable>>`	`registerPrey()` Register the calling component as a prey.

- Field Detail
  - DIRECTION_LEFT
```
static final String DIRECTION_LEFT
```
    The move direction left.
    
    See Also:
    Constant Field Values
  - DIRECTION_RIGHT
```
static final String DIRECTION_RIGHT
```
    The move direction right.
    
    See Also:
    Constant Field Values
  - DIRECTION_UP
```
static final String DIRECTION_UP
```
    The move direction up.
    
    See Also:
    Constant Field Values
  - DIRECTION_DOWN
```
static final String DIRECTION_DOWN
```
    The move direction down.
    
    See Also:
    Constant Field Values
  - DIRECTION_NONE
```
static final String DIRECTION_NONE
```
    Placeholder for "no move" action.
    
    See Also:
    Constant Field Values
- Method Detail
  - registerPrey
```
ISubscriptionIntermediateFuture<Collection<IPreyPerceivable>> registerPrey()
```
    Register the calling component as a prey.
    
    Returns:
    The subscription will publish the percepts for the prey. Termination of the subscription will destroy the prey avatar.
  - move
```
IFuture<Void> move(String direction)
```
    Perform a move action for the avatar of the calling component.
    
    Parameters:
    direction - The move direction.
    
    Returns:
    The future returns, when the action is done. If the action could not be performed (e.g. due to obstacles) an exception is returned.
  - eat
```
IFuture<Void> eat(IFood food)
```
    Perform an eat action for the avatar of the calling component.
    
    Parameters:
    food - The food to eat.
    
    Returns:
    The future returns, when the action is done. If the action could not be performed an exception is returned.

Interface IHunterPreyEnvironmentService

Field Summary

Method Summary

Field Detail

DIRECTION_LEFT

DIRECTION_RIGHT

DIRECTION_UP

DIRECTION_DOWN

DIRECTION_NONE

Method Detail

registerPrey

move

eat