SwimGoal (SpongeAPI 8.1.0-SNAPSHOT API)

All Superinterfaces:: Goal<Agent>

public interface SwimGoal
extends Goal<Agent>

Nested Class Summary

Nested Classes
Modifier and Type Interface Description

static interface SwimGoal.Builder

Method Summary

All Methods Static Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`static SwimGoal.Builder`	`builder()`	Creates a new `SwimGoal.Builder` to build a new `SwimGoal`.
`void`	`setSwimChance(float chance)`	Sets the chance that the owning `Agent` will perform a "jump".
`float`	`swimChance()`	Gets the chance that the owning `Agent` will perform a "jump".

Methods inherited from interface org.spongepowered.api.entity.ai.goal.Goal
canBeInterrupted, canRunConcurrentWith, executor, owner, type

- Method Detail
  - builder
```
static SwimGoal.Builder builder()
```
    Creates a new SwimGoal.Builder to build a new SwimGoal.
    
    Returns:
    
    A new builder
  - swimChance
```
float swimChance()
```
    Gets the chance that the owning Agent will perform a "jump". The chance is limited between 0 and 1, to where the higher the chance, the more likely the entity will "jump" to appear "swimming".
    
    Returns:
    
    The chance that the owning entity will "swim"
  - setSwimChance
```
void setSwimChance(float chance)
```
    Sets the chance that the owning Agent will perform a "jump". The chance is limited between 0 and 1, to where the higher the chance, the more likely the entity will "jump" to appear "swimming".
    
    Parameters:
    
    chance - The chance that the entity will "swim"