com.almasb.fxgl.ai.btree.leaf

Class Wait<E>

java.lang.Object

com.almasb.fxgl.ai.btree.Task<E>

com.almasb.fxgl.ai.btree.LeafTask<E>

com.almasb.fxgl.ai.btree.leaf.Wait<E>

Type Parameters:

E - type of the blackboard object that tasks use to read or modify game state

public class Wait<E>
extends LeafTask<E>

Wait is a leaf that keeps running for the specified amount of time then succeeds.

Author:

davebaol

Nested Class Summary

Nested classes/interfaces inherited from class com.almasb.fxgl.ai.btree.Task

Task.Status

Field Summary

Fields

Modifier and Type	Field and Description
FloatDistribution	seconds Mandatory task attribute specifying the random distribution that determines the timeout in seconds.

Fields inherited from class com.almasb.fxgl.ai.btree.Task

control, status, tree

Constructor Summary

Constructors

Constructor and Description
Wait() Creates a Wait task that immediately succeeds.
Wait(float seconds) Creates a Wait task running for the specified number of seconds.
Wait(FloatDistribution seconds) Creates a Wait task running for the specified number of seconds.

Method Summary

Modifier and Type	Method and Description
protected Task<E>	copyTo(Task<E> task) Copies this task to the given task.
Task.Status	execute() Executes this Wait task.
void	start() Draws a value from the distribution that determines the seconds to wait for.

Methods inherited from class com.almasb.fxgl.ai.btree.LeafTask

addChildToTask, childFail, childRunning, childSuccess, getChild, getChildCount, run

Methods inherited from class com.almasb.fxgl.ai.btree.Task

addChild, cancel, cancelRunningChildren, checkGuard, cloneTask, end, fail, getEntity, getGuard, getStatus, reset, running, setControl, setGuard, success

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

seconds

public FloatDistribution seconds

Mandatory task attribute specifying the random distribution that determines the timeout in seconds.

Constructor Detail

Wait

public Wait()

Creates a Wait task that immediately succeeds.

Wait

public Wait(float seconds)

Creates a Wait task running for the specified number of seconds.

Parameters:

seconds - the number of seconds to wait for

Wait

public Wait(FloatDistribution seconds)

Creates a Wait task running for the specified number of seconds.

Parameters:

seconds - the random distribution determining the number of seconds to wait for

Method Detail

start

public void start()

Draws a value from the distribution that determines the seconds to wait for.

This method is called when the task is entered. Also, this method internally calls GdxAI.getTimepiece().getTime() to get the current AI time. This means that

• if you forget to update the timepiece this task will keep running indefinitely.
• the timepiece should be updated before this task runs.

Overrides:

start in class Task<E>

execute

public Task.Status execute()

Executes this Wait task.

Specified by:

execute in class LeafTask<E>

Returns:

Status#SUCCEEDED if the specified timeout has expired; Status#RUNNING otherwise.

copyTo

protected Task<E> copyTo(Task<E> task)

Description copied from class: Task

Copies this task to the given task.

Specified by:

copyTo in class Task<E>

Parameters:

task - the task to be filled

Returns:

the given task for chaining