Skip to main content

App

Struct App 

Source
pub struct App {
    pub world: World,
    /* private fields */
}
Expand description

AnvilKit 应用框架

基于 Bevy ECS 构建的应用容器,提供系统调度、插件管理和生命周期控制。

§特性

  • 插件系统: 支持模块化的功能扩展
  • 系统调度: 灵活的系统执行顺序和并行控制
  • 资源管理: 全局资源的存储和访问
  • 事件系统: 组件间的松耦合通信

§示例

use anvilkit_ecs::prelude::*;
use anvilkit_ecs::schedule::AnvilKitSchedule;

let mut app = App::new();
app.add_plugins(AnvilKitEcsPlugin)
   .add_systems(AnvilKitSchedule::Update, movement_system)
   .run();

fn movement_system() {
    // 系统逻辑
}

Fields§

§world: World

ECS 世界,存储所有实体、组件和资源

Implementations§

Source§

impl App

Source

pub fn new() -> App

创建新的应用实例

§示例
use anvilkit_ecs::app::App;
 
let app = App::new();
Source

pub fn add_plugins<P>(&mut self, plugin: P) -> &mut App
where P: Plugin,

添加插件到应用

§参数
  • plugin: 要添加的插件
§示例
use anvilkit_ecs::prelude::*;
 
let mut app = App::new();
app.add_plugins(AnvilKitEcsPlugin);
Source

pub fn add_systems<M>( &mut self, schedule: impl ScheduleLabel, systems: impl IntoSystemConfigs<M>, ) -> &mut App

添加系统到指定调度

§参数
  • schedule: 调度标签
  • systems: 要添加的系统
§示例
use anvilkit_ecs::prelude::*;
use anvilkit_ecs::schedule::AnvilKitSchedule;

let mut app = App::new();
app.add_systems(AnvilKitSchedule::Update, my_system);

fn my_system() {
    println!("系统运行中");
}
Source

pub fn insert_resource<R>(&mut self, resource: R) -> &mut App
where R: Resource,

插入资源到世界

§参数
  • resource: 要插入的资源
§示例
use anvilkit_ecs::prelude::*;
 
#[derive(Resource)]
struct GameConfig {
    difficulty: u32,
}
 
let mut app = App::new();
app.insert_resource(GameConfig { difficulty: 1 });
Source

pub fn init_resource<R>(&mut self) -> &mut App
where R: Resource + FromWorld,

初始化资源(如果不存在)

§示例
use anvilkit_ecs::prelude::*;
 
#[derive(Resource, Default)]
struct Score(u32);
 
let mut app = App::new();
app.init_resource::<Score>();
Source

pub fn run(&mut self)

运行应用的主循环

这将持续运行主调度器,直到应用被标记为退出。

§示例
use anvilkit_ecs::prelude::*;
 
let mut app = App::new();
app.add_plugins(AnvilKitEcsPlugin)
   .run();
Source

pub fn update(&mut self)

执行一次更新循环

运行主调度器一次,处理所有系统。

§示例
use anvilkit_ecs::prelude::*;
 
let mut app = App::new();
app.add_plugins(AnvilKitEcsPlugin);
 
// 手动控制更新
for _ in 0..10 {
    app.update();
}
Source

pub fn exit(&mut self)

标记应用应该退出

§示例
use anvilkit_ecs::prelude::*;
 
fn exit_system(mut app_exit: ResMut<AppExit>) {
    app_exit.exit();
}
Source

pub fn should_exit(&self) -> bool

检查应用是否应该退出

Trait Implementations§

Source§

impl Default for App

Source§

fn default() -> App

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl !Freeze for App

§

impl !RefUnwindSafe for App

§

impl Send for App

§

impl Sync for App

§

impl Unpin for App

§

impl UnsafeUnpin for App

§

impl UnwindSafe for App

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> Downcast<T> for T

Source§

fn downcast(&self) -> &T

Source§

impl<T> Downcast for T
where T: Any,

Source§

fn into_any(self: Box<T>) -> Box<dyn Any>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.
Source§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait.
Source§

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s.
Source§

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s.
Source§

impl<T> DowncastSync for T
where T: Any + Send + Sync,

Source§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromWorld for T
where T: Default,

Source§

fn from_world(_world: &mut World) -> T

Creates Self using data from the given World.
Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> Upcast<T> for T

Source§

fn upcast(&self) -> Option<&T>

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> ConditionalSend for T
where T: Send,

Source§

impl<T> WasmNotSend for T
where T: Send,

Source§

impl<T> WasmNotSendSync for T

Source§

impl<T> WasmNotSync for T
where T: Sync,