Struct RuneScriptHost

pub struct RuneScriptHost<A: RuneArgs> { /* private fields */ }

Rune script host. Enables Rune scripting.

Trait Implementations

impl<A: RuneArgs> Default for RuneScriptHost<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: RuneArgs> ScriptHost for RuneScriptHost<A>

type ScriptContext = RuneScriptContext

the type of the persistent script context, representing the execution context of the script

type ScriptEvent = RuneEvent<A>

the type of events picked up by lua callbacks

type ScriptAsset = RuneFile

the type of asset representing the script files for this host

type APITarget = Context

the type representing the target of api providers, i.e. the script engine or the script context itself

type DocTarget = RuneDocFragment

the type of each doc fragment

fn register_with_app_in_set( app: &mut App, schedule: impl ScheduleLabel, set: impl SystemSet, )

Similar to register_with_app but allows you to specify a system set to add the handler to.

fn load_script( &mut self, script: &[u8], script_data: &ScriptData<'_>, providers: &mut APIProviders<Self>, ) -> Result<Self::ScriptContext, ScriptError>

Loads a script in byte array format, the script name can be used to send useful errors.

fn setup_script( &mut self, script_data: &ScriptData<'_>, ctx: &mut Self::ScriptContext, providers: &mut APIProviders<Self>, ) -> Result<(), ScriptError>

Perform one-off initialization of scripts (happens for every new or re-loaded script)

fn handle_events<'a>( &mut self, world: &mut World, events: &[Self::ScriptEvent], ctxs: impl Iterator<Item = (ScriptData<'a>, &'a mut Self::ScriptContext)>, providers: &mut APIProviders<Self>, )

the main point of contact with the bevy world. Scripts are called with appropriate events in the event order

fn run_one_shot( &mut self, script: &[u8], script_name: &str, entity: Entity, world: &mut World, event: Self::ScriptEvent, ) -> Result<(), ScriptError>

Loads and runs script instantaneously without storing any script data into the world. The script id is set to u32::MAX.

fn register_with_app(app: &mut App, schedule: impl ScheduleLabel)

Registers the script host with the given app, and attaches handlers to deal with spawning/removing scripts in the given System Set.

impl<A: RuneArgs> Resource for RuneScriptHost<A>

where Self: Send + Sync + 'static,