Skip to main content

LuarsScriptingPlugin

Struct LuarsScriptingPlugin 

Source
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’s World;
  • entity, the entity the script is attached to, when there is one;
  • script_asset, the Handle<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

Source§

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

Source§

fn default() -> Self

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

impl GetPluginThreadConfig<LuarsScriptingPlugin> for LuarsScriptingPlugin

Source§

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>, )

Set the configuration or overwrites it if already set.
Source§

impl IntoScriptPluginParams for LuarsScriptingPlugin

Source§

const LANGUAGE: Language = Language::Lua

The language of the scripts
Source§

type C = LuarsContext

The context type used for the scripts
Source§

type R = ()

The runtime type used for the scripts
Source§

fn build_runtime() -> Self::R

Build the runtime
Source§

fn handler() -> HandlerFn<Self>

Returns the handler function for the plugin
Source§

fn context_loader() -> ContextLoadFn<Self>

Returns the context loader function for the plugin
Source§

fn context_reloader() -> ContextReloadFn<Self>

Returns the context reloader function for the plugin
Source§

impl Plugin for LuarsScriptingPlugin

Source§

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

Configures the App to which this plugin is added.
Source§

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

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)

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

fn name(&self) -> &str

Configures a name for the Plugin which is primarily used for checking plugin uniqueness and debugging.
Source§

fn is_unique(&self) -> bool

If the plugin can be meaningfully instantiated several times in an App, override this method to return false.

Auto Trait Implementations§

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> ConditionalSend for T
where T: Send,

Source§

impl<P> ConfigureScriptPlugin for P

Source§

type P = P

The type of the plugin to configure
Source§

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

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

Add a runtime initializer to the plugin
Source§

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

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 more
Source§

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

removes a supported file extension for the plugin’s language.
Source§

fn set_pipeline_settings(self, pipeline: ScriptLoadingPipeline<P>) -> P

Sets the script pipeline settings plugin
Source§

impl<T> Context for T
where T: 'static + Send + Any,

Source§

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

Source§

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>

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)

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)

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
where T: Any + Send,

Source§

fn into_any_send(self: Box<T>) -> Box<dyn Any + Send>

Converts Box<Trait> (where Trait: DowncastSend) to Box<dyn Any + Send>, which can then be downcast into Box<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 default().

Source§

impl<T, W> HasTypeWitness<W> for T
where W: MakeTypeWitness<Arg = T>, T: ?Sized,

Source§

const WITNESS: W = W::MAKE

A constant of the type witness
Source§

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

Source§

const TYPE_EQ: TypeEq<T, <T as Identity>::Type> = TypeEq::NEW

Proof that Self is the same type as Self::Type, provides methods for casting between Self and Self::Type.
Source§

type Type = T

The same type as Self, used to emulate type equality bounds (T == U) with associated type equality constraints (T: Identity<Type = U>).
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> IntoNamespace for T
where T: 'static + ?Sized,

Source§

fn into_namespace() -> Namespace

Converts this type into a Namespace
Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<A> Is for A
where A: Any,

Source§

fn is<T>() -> bool
where T: Any,

Checks if the current type “is” another type, using a TypeId equality comparison. This is most useful in the context of generic logic. Read more
Source§

impl<T> LuaMethodProvider for T

Source§

impl<T> LuaStaticMethodProvider for T

Source§

fn __lua_static_methods() -> &'static [(&'static str, fn(&mut LuaState) -> Result<usize, LuaError>)]

Source§

impl<Marker, T> Plugins<Marker> for T
where T: Plugins<Marker>,

Source§

impl<T> Runtime for T
where T: Default + 'static + Send + Sync,

Source§

impl<P> ScriptingHandler<P> for P

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>

Calls the handler function while providing the necessary thread local context

Source§

impl<P> ScriptingLoader<P> for P

Source§

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>

Reloads a script context using the provided reloader function
Source§

impl<T> Settings for T
where T: 'static + Send + Sync,

Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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