org.spongepowered.api.entity.ai.task.builtin

Interface SwimmingAITask

All Superinterfaces:

AITask<Agent>

public interface SwimmingAITask
extends AITask<Agent>

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	SwimmingAITask.Builder

Method Summary

Modifier and Type	Method and Description
static SwimmingAITask.Builder	builder() Creates a new SwimmingAITask.Builder to build a new SwimmingAITask.
float	getSwimChance() Gets the chance that the owning Agent will perform a "jump".
void	setSwimChance(float chance) Sets the chance that the owning Agent will perform a "jump".

Methods inherited from interface org.spongepowered.api.entity.ai.task.AITask

canBeInterrupted, canRunConcurrentWith, getGoal, getOwner, getType

Method Detail

builder

static SwimmingAITask.Builder builder()

Creates a new SwimmingAITask.Builder to build a new SwimmingAITask.

Returns:

A new builder

getSwimChance

float getSwimChance()

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"