Struct RhaiScriptingPlugin 

pub struct RhaiScriptingPlugin {
    pub scripting_plugin: ScriptingPlugin<RhaiScriptingPlugin>,
}

The rhai scripting plugin. Used to add rhai scripting to a bevy app within the context of the BMS framework.

Fields

scripting_plugin: ScriptingPlugin<RhaiScriptingPlugin>

The internal scripting plugin

Trait Implementations

impl AsMut<ScriptingPlugin<RhaiScriptingPlugin>> for RhaiScriptingPlugin

fn as_mut(&mut self) -> &mut ScriptingPlugin<RhaiScriptingPlugin>

Converts this type into a mutable reference of the (usually inferred) input type.

impl Default for RhaiScriptingPlugin

fn default() -> RhaiScriptingPlugin

Returns the “default value” for a type.

impl GetPluginThreadConfig<RhaiScriptingPlugin> for RhaiScriptingPlugin

fn readonly_configuration( world: WorldId, ) -> ScriptingPluginConfiguration<RhaiScriptingPlugin>

Get a reference to the readonly configuration.

fn set_world_local_config( world: WorldId, config: ScriptingPluginConfiguration<RhaiScriptingPlugin>, )

Set the configuration or overwrites it if already set.

impl IntoScriptPluginParams for RhaiScriptingPlugin

const LANGUAGE: Language = Language::Rhai

The language of the scripts

type C = RhaiScriptContext

The context type used for the scripts

type R = RwLock<RawRwLock, Engine>

The runtime type used for the scripts

fn build_runtime() -> <RhaiScriptingPlugin as IntoScriptPluginParams>::R

Build the runtime

fn handler() -> fn(Vec<ScriptValue>, &ScriptAttachment, &CallbackLabel, &mut <RhaiScriptingPlugin as IntoScriptPluginParams>::C, WorldId) -> Result<ScriptValue, InteropError>

Returns the handler function for the plugin

fn context_loader() -> fn(&ScriptAttachment, &[u8], WorldId) -> Result<<RhaiScriptingPlugin as IntoScriptPluginParams>::C, InteropError>

Returns the context loader function for the plugin

fn context_reloader() -> fn(&ScriptAttachment, &[u8], &mut <RhaiScriptingPlugin as IntoScriptPluginParams>::C, WorldId) -> Result<(), InteropError>

Returns the context reloader function for the plugin

impl Plugin for RhaiScriptingPlugin

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

Configures the App to which this plugin is added.

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 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 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.