Enum Behavior

pub enum Behavior<A> {
    WaitForPressed(Button),
    WaitForReleased(Button),
    Wait(f64),
    WaitForever,
    Action(A),
    Fail(Box<Behavior<A>>),
    AlwaysSucceed(Box<Behavior<A>>),
    Select(Vec<Behavior<A>>),
    If(Box<Behavior<A>>, Box<Behavior<A>>, Box<Behavior<A>>),
    Sequence(Vec<Behavior<A>>),
    While(Box<Behavior<A>>, Vec<Behavior<A>>),
    WhenAll(Vec<Behavior<A>>),
    WhenAny(Vec<Behavior<A>>),
    After(Vec<Behavior<A>>),
}

Describes a behavior.

This is used for more complex event logic. Can also be used for game AI.

Variants

WaitForPressed(Button)

Wait for a button to be pressed.

Returns Success when the button is pressed, otherwise it returns Running.

WaitForReleased(Button)

Wait for a button to be released.

Returns Success when the button is released, otherwise it returns Running.

Wait(f64)

Waits an amount of time before continuing.

f64: Time in seconds

WaitForever

Wait forever.

Action(A)

A high level description of an action.

Fail(Box<Behavior<A>>)

Converts Success into Failure and vice versa.

AlwaysSucceed(Box<Behavior<A>>)

Ignores failures and returns Success.

Select(Vec<Behavior<A>>)

Runs behaviors one by one until a behavior succeeds.

If a behavior fails it will try the next one. Fails if the last behavior fails. Can be thought of as a short-circuited logical OR gate.

If(Box<Behavior<A>>, Box<Behavior<A>>, Box<Behavior<A>>)

If(condition, success, failure)

Sequence(Vec<Behavior<A>>)

Runs behaviors one by one until all succeeded.

The sequence fails if a behavior fails. The sequence succeeds if all the behavior succeeds. Can be thought of as a short-circuited logical AND gate.

While(Box<Behavior<A>>, Vec<Behavior<A>>)

Loops while conditional behavior is running.

Succeeds if the conditional behavior succeeds. Fails if the conditional behavior fails, or if any behavior in the loop body fails.

WhenAll(Vec<Behavior<A>>)

Runs all behaviors in parallel until all succeeded.

Succeeds if all behaviors succeed. Fails is any behavior fails.

WhenAny(Vec<Behavior<A>>)

Runs all behaviors in parallel until one succeeds.

Succeeds if one behavior succeeds. Fails if all behaviors failed.

After(Vec<Behavior<A>>)

Runs all behaviors in parallel until all succeeds in sequence.

Succeeds if all behaviors succeed, but only if succeeding in sequence. Fails if one behavior fails.

Trait Implementations

impl<A: Clone> Clone for Behavior<A>

fn clone(&self) -> Behavior<A>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'de, A> Deserialize<'de> for Behavior<A>

where A: Deserialize<'de>,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<A: PartialEq> PartialEq for Behavior<A>

fn eq(&self, other: &Behavior<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A> Serialize for Behavior<A>

where A: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<A> StructuralPartialEq for Behavior<A>