pub struct CooldownNode { /* private fields */ }Expand description
Bounds the GAP between runs of its child, the complement of TimeoutNode (which bounds how
long a single run may stay Running). Once the child returns a terminal result (Success or
Failure), this node refuses to re-tick it for cooldown: during that window tick()
returns Failure immediately WITHOUT ticking the child at all. Once the window elapses,
ticking resumes normally. A child that returns Running doesn’t start the cooldown clock -
only a terminal result does.
Implementations§
Source§impl CooldownNode
impl CooldownNode
Sourcepub fn new(child: BoxedBehavior, cooldown: Duration) -> Self
pub fn new(child: BoxedBehavior, cooldown: Duration) -> Self
Create a new cooldown node wrapping child, refusing to re-tick it for cooldown after
it last resolved.
Trait Implementations§
Source§impl BehaviorNode for CooldownNode
impl BehaviorNode for CooldownNode
Source§fn tick<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn tick<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Execute one tick of the behavior. Called repeatedly by the execution engine; should
perform one unit of work, return quickly, and report progress via
NodeStatus.Source§fn reset_self(&mut self)
fn reset_self(&mut self)
Reset this node’s own local state, ignoring children. Read more
Source§fn children_mut(&mut self) -> Vec<&mut dyn BehaviorNode>
fn children_mut(&mut self) -> Vec<&mut dyn BehaviorNode>
Return mutable references to this node’s child behaviors, in the order
they should receive lifecycle events. Leaf nodes should not override this;
composite nodes override it to expose their children.
Source§fn active_capability(&self) -> Option<&str>
fn active_capability(&self) -> Option<&str>
The
capability this node implies should be published on /behavior/status while it’s
actively being ticked; None for nodes with no such gate (the default). Composite nodes
override this to forward whichever child is currently active.Source§fn status_snapshot(&self) -> TreeStatusSnapshot
fn status_snapshot(&self) -> TreeStatusSnapshot
Snapshot of what this node (and, for composite nodes, its subtree) reported on its last
tick(), for live behavior-tree visualization. The default implementation reports
status: None (as if never ticked) and no children - correct for a brand-new node type
that hasn’t been wired up for status tracking yet, but every node type should override
this once it stores a last_status field: leaf nodes return their own last_status,
composite nodes additionally recurse into children_mut’s non-mut counterpart (there’s
no shared non-mut child accessor, so each composite overrides this to walk its own child
collection directly - same pattern as children_mut).Source§fn reset<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
fn reset<'life0, 'async_trait>(
&'life0 mut self,
) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>where
Self: 'async_trait,
'life0: 'async_trait,
Reset the behavior to its initial state. Read more
Auto Trait Implementations§
impl !RefUnwindSafe for CooldownNode
impl !UnwindSafe for CooldownNode
impl Freeze for CooldownNode
impl Send for CooldownNode
impl Sync for CooldownNode
impl Unpin for CooldownNode
impl UnsafeUnpin for CooldownNode
Blanket Implementations§
Source§impl<T> BehaviorNodeExt for Twhere
T: BehaviorNode + ?Sized,
impl<T> BehaviorNodeExt for Twhere
T: BehaviorNode + ?Sized,
Source§fn run_until_complete<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn run_until_complete<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Run this behavior until it completes (Success or Failure). Read more
Source§fn run_with_limit<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
max_ticks: usize,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
fn run_with_limit<'life0, 'life1, 'async_trait>(
&'life0 mut self,
ctx: &'life1 Context,
max_ticks: usize,
) -> Pin<Box<dyn Future<Output = Result<NodeStatus>> + Send + 'async_trait>>where
Self: Send + 'async_trait,
'life0: 'async_trait,
'life1: 'async_trait,
Run this behavior with a maximum number of ticks. Read more
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more