Struct AbilityPlugin 

pub struct AbilityPlugin<A: Abilitylike> { /* private fields */ }

A Plugin that advances the abilities of type A.

This plugin ticks down the CooldownState and ChargeState components of every entity with abilities of type A, replenishing charges and refreshing cooldowns as they expire.

This plugin needs to be passed in an Abilitylike enum type that you’ve created for your game. If you have more than one distinct type of action (e.g. menu actions, camera actions and player actions), consider creating multiple Abilitylike enums and adding a copy of this plugin for each Abilitylike type.

Systems

The plugin adds tick_cooldowns to PreUpdate, in the AbilitySystem::TickCooldowns set. It is ordered before InputManagerSystem::Update, so cooldowns are advanced before action states are updated for the frame.

WARNING: These systems run during PreUpdate. If you have systems that care about inputs and actions that also run during this stage, you must define an ordering between your systems or behavior will be very erratic.

Trait Implementations

impl<A: Abilitylike> Default for AbilityPlugin<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: Abilitylike> Plugin for AbilityPlugin<A>

fn build(&self, app: &mut App)

Configures the App to which this plugin is added.

fn ready(&self, _app: &App) -> bool

Has the plugin finished its setup? This can be useful for plugins that need something asynchronous to happen before they can finish their setup, like the initialization of a renderer. Once the plugin is ready, finish should be called.

fn finish(&self, _app: &mut App)

Finish adding this plugin to the App, once all plugins registered are ready. This can be useful for plugins that depends on another plugin asynchronous setup, like the renderer.

fn cleanup(&self, _app: &mut App)

Runs after all plugins are built and finished, but before the app schedule is executed. This can be useful if you have some resource that other plugins need during their build step, but after build you want to remove it and send it to another thread.

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.