📜 入门指南

插件

开始的最快方法是向您的App添加SequentialActionsPlugin。

use bevy_sequential_actions::*;

fn main() {
    App::new()
        .add_plugins(SequentialActionsPlugin)
        .run();
}

修改动作

动作是任何实现了Action特质的东西，并且可以添加到包含ActionsBundle的任何Entity中。具有动作的实体被称为agent。有关可用方法，请参阅ModifyActions特质。

fn setup(mut commands: Commands) {
    let agent = commands.spawn(ActionsBundle::new()).id();
    commands
        .actions(agent)
        .add(action_a)
        .add_many(actions![
            action_b,
            action_c
        ])
        .order(AddOrder::Front)
        .add(action_d)
        // ...
}

实现动作

Action特质包含3个必需的方法

• is_finished，用于确定动作是否完成。
• on_start，在动作开始时调用。
• on_stop，在动作停止时调用。

此外，还有3个可选方法

• on_add，在动作添加到队列时调用。
• on_remove，在动作从队列中删除时调用。
• on_drop，这是最后一个调用完全所有权的最后一个方法。

以下是一个简单的等待动作。

pub struct WaitAction {
    duration: f32, // Seconds
    current: Option<f32>, // None
}

impl Action for WaitAction {
    fn is_finished(&self, agent: Entity, world: &World) -> bool {
        // Determine if wait timer has reached zero.
        // By default, this method is called every frame in the Last schedule.
        world.get::<WaitTimer>(agent).unwrap().0 <= 0.0
    }

    fn on_start(&mut self, agent: Entity, world: &mut World) -> bool {
        // Take current time (if paused), or use full duration.
        let duration = self.current.take().unwrap_or(self.duration);

        // Run the wait timer system on the agent.
        world.entity_mut(agent).insert(WaitTimer(duration));

        // Is action already finished?
        // Returning true here will immediately advance the action queue.
        self.is_finished(agent, world)
    }

    fn on_stop(&mut self, agent: Entity, world: &mut World, reason: StopReason) {
        // Take the wait timer component from the agent.
        let wait_timer = world.entity_mut(agent).take::<WaitTimer>();

        // Store current time when paused.
        if reason == StopReason::Paused {
            self.current = Some(wait_timer.unwrap().0);
        }
    }
}

#[derive(Component)]
struct WaitTimer(f32);

fn wait_system(mut wait_timer_q: Query<&mut WaitTimer>, time: Res<Time>) {
    for mut wait_timer in &mut wait_timer_q {
        wait_timer.0 -= time.delta_seconds();
    }
}

⚠️ 警告

需要注意的一点是在Action特质内部使用World修改动作。为了在调用特质方法时传递对世界的可变引用，必须暂时从agent中移除动作。这意味着，根据您的操作，动作队列的推进逻辑可能不会正常工作。

通常，在动作特质内部修改agent的动作时有两条规则

• 在添加新动作时，您应该将start属性设置为false，或者直接推送到ActionQueue组件。
• 不应使用execute和next方法。

📎 示例

请参阅示例以获取更多使用信息。每个示例都可以通过以下命令运行：cargo run --example <example>。

📌 兼容性

🔖 许可证

bevy-sequential-actions可以根据您的选择采用以下任一许可证：

• MIT 许可证 (LICENSE-MIT 或 https://open-source.org.cn/licenses/MIT)
• Apache 许可证，版本 2.0 (LICENSE-APACHE 或 https://apache.ac.cn/licenses/LICENSE-2.0)

任选其一。