Struct bones_scripting::lua::LuaPlugin

pub struct LuaPlugin {
    pub source: String,
    pub systems: LuaPluginSystemsCell,
}

A lua plugin asset.

This differs from LuaScript in that loaded LuaPlugins will be automatically registered and run by the bones framework and LuaScript must be manually triggered by your systems.

Fields

source: String

The lua source of the script.

systems: LuaPluginSystemsCell

The lua closures, registered by the script, to run in different system stages.

Implementations

impl LuaPlugin

pub fn has_loaded(&self) -> bool

Whether or not the plugin has loaded it’s systems.

pub fn load( &self, executor: Arc<ThreadExecutor<'static>>, lua: &mut Lua, ) -> Result<(), Error>

Load the lua plugin’s systems.

Trait Implementations

impl Drop for LuaPlugin

fn drop(&mut self)

Executes the destructor for this type.

impl HasSchema for LuaPlugin

fn schema() -> &'static Schema

Get this type’s [Schema].

fn register_schema()

Register this schema with the global schema registry.

fn cast<T>(this: &Self) -> &T

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn try_cast<T>(this: &Self) -> Result<&T, SchemaMismatchError>

where T: HasSchema,

Cast a reference of this type to a reference of another type with the same memory layout.

fn cast_mut<T>(this: &mut Self) -> &mut T

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn try_cast_mut<T>(this: &mut Self) -> Result<&mut T, SchemaMismatchError>

where T: HasSchema,

Cast a mutable reference of this type to a reference of another type with the same memory layout.

fn as_schema_ref(&self) -> SchemaRef<'_>

where Self: Sized,

Converts a reference of T to a [SchemaRef]

fn as_schema_mut(&mut self) -> SchemaRefMut<'_>

where Self: Sized,

Converts a reference of T to a [SchemaRefMut]