pub struct LuarsScriptingPlugin {
pub scripting_plugin: ScriptingPlugin<Self>,
}Expand description
BMS language plugin that runs Lua 5.5 via luars instead of mlua.
Add this next to BMSPlugin. Leave BMS’s lua / lua54 features off so
you do not load two Lua VMs.
ⓘ
use bevy::prelude::*;
use bevy_mod_scripting::BMSPlugin;
use bevy_mod_scripting_luars::LuarsScriptingPlugin;
App::new()
.add_plugins((BMSPlugin, LuarsScriptingPlugin::default()))
.run();After that, treat this like any other BMS language: load .lua / .luau
assets and attach them with ScriptComponent.
§What scripts see
Each context gets
world, a static handle to Bevy’sWorld;entity, the entity the script is attached to, when there is one;script_asset, theHandle<ScriptAsset>for this script;register_callback(name, fn), subscribe a Lua function to a BMS callback; and- every global and global-namespace function from the BMS registries.
Configure with bevy_mod_scripting_core::ConfigureScriptPlugin
(set_context_policy, add_context_initializer, and so on).
Fields§
§scripting_plugin: ScriptingPlugin<Self>Inner BMS plugin. Prefer ConfigureScriptPlugin helpers when you can.
Trait Implementations§
Source§impl AsMut<ScriptingPlugin<LuarsScriptingPlugin>> for LuarsScriptingPlugin
impl AsMut<ScriptingPlugin<LuarsScriptingPlugin>> for LuarsScriptingPlugin
Source§fn as_mut(&mut self) -> &mut ScriptingPlugin<LuarsScriptingPlugin>
fn as_mut(&mut self) -> &mut ScriptingPlugin<LuarsScriptingPlugin>
Converts this type into a mutable reference of the (usually inferred) input type.
Source§impl Default for LuarsScriptingPlugin
impl Default for LuarsScriptingPlugin
Source§impl GetPluginThreadConfig<LuarsScriptingPlugin> for LuarsScriptingPlugin
impl GetPluginThreadConfig<LuarsScriptingPlugin> for LuarsScriptingPlugin
Source§fn readonly_configuration(
world: WorldId,
) -> ScriptingPluginConfiguration<LuarsScriptingPlugin>
fn readonly_configuration( world: WorldId, ) -> ScriptingPluginConfiguration<LuarsScriptingPlugin>
Get a reference to the readonly configuration.
Source§fn set_world_local_config(
world: WorldId,
config: ScriptingPluginConfiguration<LuarsScriptingPlugin>,
)
fn set_world_local_config( world: WorldId, config: ScriptingPluginConfiguration<LuarsScriptingPlugin>, )
Set the configuration or overwrites it if already set.
Source§impl IntoScriptPluginParams for LuarsScriptingPlugin
impl IntoScriptPluginParams for LuarsScriptingPlugin
Source§type C = LuarsContext
type C = LuarsContext
The context type used for the scripts
Source§fn build_runtime() -> Self::R
fn build_runtime() -> Self::R
Build the runtime
Source§fn context_loader() -> ContextLoadFn<Self>
fn context_loader() -> ContextLoadFn<Self>
Returns the context loader function for the plugin
Source§fn context_reloader() -> ContextReloadFn<Self>
fn context_reloader() -> ContextReloadFn<Self>
Returns the context reloader function for the plugin
Source§impl Plugin for LuarsScriptingPlugin
impl Plugin for LuarsScriptingPlugin
Source§fn finish(&self, app: &mut App)
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.Source§fn ready(&self, _app: &App) -> bool
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.Source§fn cleanup(&self, _app: &mut App)
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.
Auto Trait Implementations§
impl !RefUnwindSafe for LuarsScriptingPlugin
impl !UnwindSafe for LuarsScriptingPlugin
impl Freeze for LuarsScriptingPlugin
impl Send for LuarsScriptingPlugin
impl Sync for LuarsScriptingPlugin
impl Unpin for LuarsScriptingPlugin
impl UnsafeUnpin for LuarsScriptingPlugin
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> ConditionalSend for Twhere
T: Send,
Source§impl<P> ConfigureScriptPlugin for P
impl<P> ConfigureScriptPlugin for P
Source§fn add_context_initializer(
self,
initializer: fn(&ScriptAttachment, &mut <<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::C) -> Result<(), InteropError>,
) -> P
fn add_context_initializer( self, initializer: fn(&ScriptAttachment, &mut <<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::C) -> Result<(), InteropError>, ) -> P
Add a context initializer to the plugin
Source§fn add_context_pre_handling_initializer(
self,
initializer: fn(&ScriptAttachment, &mut <<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::C) -> Result<(), InteropError>,
) -> P
fn add_context_pre_handling_initializer( self, initializer: fn(&ScriptAttachment, &mut <<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::C) -> Result<(), InteropError>, ) -> P
Add a context pre-handling initializer to the plugin
Source§fn add_runtime_initializer(
self,
initializer: fn(&<<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::R) -> Result<(), ScriptError>,
) -> P
fn add_runtime_initializer( self, initializer: fn(&<<P as ConfigureScriptPlugin>::P as IntoScriptPluginParams>::R) -> Result<(), ScriptError>, ) -> P
Add a runtime initializer to the plugin
Source§fn set_context_policy(self, policy: ContextPolicy) -> P
fn set_context_policy(self, policy: ContextPolicy) -> P
Switch the context assigning strategy to the given policy. Read more
Source§fn emit_core_callback_responses(self, emit_responses: bool) -> P
fn emit_core_callback_responses(self, emit_responses: bool) -> P
Whether to emit responses from core script callbacks like
on_script_loaded or on_script_unloaded.
By default, this is false and responses are not emitted. Read moreSource§fn add_supported_extension(self, extension: &'static str) -> P
fn add_supported_extension(self, extension: &'static str) -> P
Adds a supported file extension for the plugin’s language.
Source§fn remove_supported_extension(self, extension: &'static str) -> P
fn remove_supported_extension(self, extension: &'static str) -> P
removes a supported file extension for the plugin’s language.
Source§fn set_pipeline_settings(self, pipeline: ScriptLoadingPipeline<P>) -> P
fn set_pipeline_settings(self, pipeline: ScriptLoadingPipeline<P>) -> P
Sets the script pipeline settings plugin
impl<T> Context for T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Converts
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>, which can then be
downcast into Box<dyn ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Converts
Rc<Trait> (where Trait: Downcast) to Rc<Any>, which can then be further
downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Converts
&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)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Converts
&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> DowncastSend for T
impl<T> DowncastSend for T
Source§impl<T> FromWorld for Twhere
T: Default,
impl<T> FromWorld for Twhere
T: Default,
Source§fn from_world(_world: &mut World) -> T
fn from_world(_world: &mut World) -> T
Creates Self using default().
Source§impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
impl<T, W> HasTypeWitness<W> for Twhere
W: MakeTypeWitness<Arg = T>,
T: ?Sized,
Source§impl<T> Identity for Twhere
T: ?Sized,
impl<T> Identity for Twhere
T: ?Sized,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§fn in_current_span(self) -> Instrumented<Self> ⓘ
fn in_current_span(self) -> Instrumented<Self> ⓘ
Source§impl<T> IntoNamespace for Twhere
T: 'static + ?Sized,
impl<T> IntoNamespace for Twhere
T: 'static + ?Sized,
Source§fn into_namespace() -> Namespace
fn into_namespace() -> Namespace
Converts this type into a
NamespaceSource§impl<T> IntoResult<T> for T
impl<T> IntoResult<T> for T
Source§fn into_result(self) -> Result<T, RunSystemError>
fn into_result(self) -> Result<T, RunSystemError>
Converts this type into the system output type.
Source§impl<T> LuaMethodProvider for T
impl<T> LuaMethodProvider for T
Source§impl<T> LuaStaticMethodProvider for T
impl<T> LuaStaticMethodProvider for T
impl<Marker, T> Plugins<Marker> for Twhere
T: Plugins<Marker>,
impl<T> Runtime for T
Source§impl<P> ScriptingHandler<P> for Pwhere
P: IntoScriptPluginParams,
impl<P> ScriptingHandler<P> for Pwhere
P: IntoScriptPluginParams,
Source§fn handle(
args: Vec<ScriptValue>,
attachment: &ScriptAttachment,
callback: &CallbackLabel,
script_ctxt: &Arc<Mutex<RawMutex, <P as IntoScriptPluginParams>::C>>,
script_callbacks: ScriptCallbacks<P>,
world: WorldAccessGuard<'_>,
) -> Result<ScriptValue, InteropError>
fn handle( args: Vec<ScriptValue>, attachment: &ScriptAttachment, callback: &CallbackLabel, script_ctxt: &Arc<Mutex<RawMutex, <P as IntoScriptPluginParams>::C>>, script_callbacks: ScriptCallbacks<P>, world: WorldAccessGuard<'_>, ) -> Result<ScriptValue, InteropError>
Calls the handler function while providing the necessary thread local context
Source§impl<P> ScriptingLoader<P> for Pwhere
P: IntoScriptPluginParams,
impl<P> ScriptingLoader<P> for Pwhere
P: IntoScriptPluginParams,
Source§fn load(
attachment: &ScriptAttachment,
content: &[u8],
world: WorldAccessGuard<'_>,
) -> Result<<P as IntoScriptPluginParams>::C, InteropError>
fn load( attachment: &ScriptAttachment, content: &[u8], world: WorldAccessGuard<'_>, ) -> Result<<P as IntoScriptPluginParams>::C, InteropError>
Loads a script context using the provided loader function
Source§fn reload(
attachment: &ScriptAttachment,
content: &[u8],
previous_context: &mut <P as IntoScriptPluginParams>::C,
world: WorldAccessGuard<'_>,
) -> Result<(), InteropError>
fn reload( attachment: &ScriptAttachment, content: &[u8], previous_context: &mut <P as IntoScriptPluginParams>::C, world: WorldAccessGuard<'_>, ) -> Result<(), InteropError>
Reloads a script context using the provided reloader function