Struct bevy_scriptum::ScriptingRuntime

pub struct ScriptingRuntime { /* private fields */ }

Implementations

impl ScriptingRuntime

pub fn engine_mut(&mut self) -> &mut Engine

Get a mutable reference to the internal rhai::Engine.

Examples found in repository

examples/custom_type.rs (line 25)

fn startup(
    mut commands: Commands,
    mut scripting_runtime: ResMut<ScriptingRuntime>,
    assets_server: Res<AssetServer>,
) {
    let engine = scripting_runtime.engine_mut();

    engine
        .register_type_with_name::<MyType>("MyType")
        // Register a method on MyType
        .register_fn("my_method", |my_type_instance: &mut MyType| {
            my_type_instance.my_field
        })
        // Register a "constructor" for MyType
        .register_fn("new_my_type", || MyType { my_field: 42 });

    commands.spawn(Script::new(assets_server.load("examples/custom_type.rhai")));
}

pub fn call_fn( &mut self, function_name: &str, script_data: &mut ScriptData, entity: Entity, args: impl FuncArgs ) -> Result<(), ScriptingError>

Call a function that is available in the scope of the script.

Examples found in repository

examples/call_function_from_rust.rs (line 45)

fn call_rhai_on_update_from_rust(
    mut scripted_entities: Query<(Entity, &mut ScriptData)>,
    mut scripting_runtime: ResMut<ScriptingRuntime>,
) {
    for (entity, mut script_data) in &mut scripted_entities {
        scripting_runtime
            .call_fn("on_update", &mut script_data, entity, ())
            .unwrap();
    }
}

Trait Implementations

impl Default for ScriptingRuntime

fn default() -> ScriptingRuntime

Returns the “default value” for a type.

impl Resource for ScriptingRuntime

where Self: Send + Sync + 'static,