Struct ScriptingPlugin 

pub struct ScriptingPlugin<P: IntoScriptPluginParams> {
    pub runtime_initializers: Vec<RuntimeInitializer<P>>,
    pub context_policy: ContextPolicy,
    pub language: Language,
    pub supported_extensions: Vec<&'static str>,
    pub context_initializers: Vec<ContextInitializer<P>>,
    pub context_pre_handling_initializers: Vec<ContextPreHandlingInitializer<P>>,
    pub emit_responses: bool,
    pub processing_pipeline_plugin: ScriptLoadingPipeline<P>,
}

Bevy plugin enabling scripting within the bevy mod scripting framework

Fields

runtime_initializers: Vec<RuntimeInitializer<P>>

Functions configuring the runtime after it is created

context_policy: ContextPolicy

The strategy used to assign contexts to scripts

language: Language

The language this plugin declares

supported_extensions: Vec<&'static str>

Declares the file extensions this plugin supports

context_initializers: Vec<ContextInitializer<P>>

initializers for the contexts, run when loading the script

context_pre_handling_initializers: Vec<ContextPreHandlingInitializer<P>>

initializers for the contexts run every time before handling events

emit_responses: bool

Whether to emit responses from core script callbacks like on_script_loaded or on_script_unloaded.

processing_pipeline_plugin: ScriptLoadingPipeline<P>

The settings customising the processing (loading, unloading etc.) pipeline for this plugin

Implementations

impl<P: IntoScriptPluginParams> ScriptingPlugin<P>

pub fn add_context_initializer( &mut self, initializer: ContextInitializer<P>, ) -> &mut Self

Adds a context initializer to the plugin

Initializers will be run every time a context is loaded or re-loaded and before any events are handled

pub fn add_context_pre_handling_initializer( &mut self, initializer: ContextPreHandlingInitializer<P>, ) -> &mut Self

Adds a context pre-handling initializer to the plugin.

Initializers will be run every time before handling events and after the context is loaded or re-loaded.

pub fn add_runtime_initializer( &mut self, initializer: RuntimeInitializer<P>, ) -> &mut Self

Adds a runtime initializer to the plugin.

Initializers will be run after the runtime is created, but before any contexts are loaded.

pub fn set_pipeline_settings( &mut self, pipeline: ScriptLoadingPipeline<P>, ) -> &mut Self

Sets the script pipeline settings plugin

Trait Implementations

impl<P> Debug for ScriptingPlugin<P>

where P: IntoScriptPluginParams,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<P: IntoScriptPluginParams> Default for ScriptingPlugin<P>

fn default() -> Self

Returns the “default value” for a type.

impl<P: IntoScriptPluginParams> Plugin for ScriptingPlugin<P>

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.