Struct bevy_mod_scripting_rhai::RhaiScriptHost

pub struct RhaiScriptHost<A: FuncArgs + Send> {
    pub engine: Engine,
    /* private fields */
}

Fields

engine: Engine

Trait Implementations

impl<A: FuncArgs + Send> Default for RhaiScriptHost<A>

fn default() -> Self

Returns the “default value” for a type.

impl<A: FuncArgs + Send + Clone + Sync + 'static> ScriptHost for RhaiScriptHost<A>

type ScriptContext = RhaiContext

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

type ScriptEvent = RhaiEvent<A>

the type of events picked up by lua callbacks

type ScriptAsset = RhaiFile

the type of asset representing the script files for this host

type APITarget = Engine

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

type DocTarget = RhaiDocFragment

the type of each doc fragment

fn register_with_app(app: &mut App, stage: impl StageLabel)

Registers the script host with the given app, and attaches handlers to deal with spawning/removing scripts at the given stage.

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 load_script(
    &mut self,
    script: &[u8],
    script_data: &ScriptData<'_>,
    _: &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 handle_events<'a>(
    &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.

impl<A: FuncArgs + Send> Resource for RhaiScriptHost<A>where
    Self: Send + Sync + 'static,