Struct bevy_mod_scripting_rhai::RhaiScriptHost
source · pub struct RhaiScriptHost<A: FuncArgs + Send> {
pub engine: Engine,
/* private fields */
}
Fields§
§engine: Engine
Trait Implementations§
source§impl<A: FuncArgs + Send + Clone + Sync + 'static> ScriptHost for RhaiScriptHost<A>
impl<A: FuncArgs + Send + Clone + Sync + 'static> ScriptHost for RhaiScriptHost<A>
§type ScriptContext = RhaiContext
type ScriptContext = RhaiContext
the type of the persistent script context, representing the execution context of the script
§type ScriptEvent = RhaiEvent<A>
type ScriptEvent = RhaiEvent<A>
the type of events picked up by lua callbacks
§type ScriptAsset = RhaiFile
type ScriptAsset = RhaiFile
the type of asset representing the script files for this host
§type APITarget = Engine
type APITarget = Engine
the type representing the target of api providers, i.e. the
script engine or the script context itself
§type DocTarget = RhaiDocFragment
type DocTarget = RhaiDocFragment
the type of each doc fragment
source§fn register_with_app_in_set(
app: &mut App,
schedule: impl ScheduleLabel,
set: impl SystemSet
)
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.source§fn setup_script(
&mut self,
script_data: &ScriptData<'_>,
ctx: &mut Self::ScriptContext,
providers: &mut APIProviders<Self>
) -> Result<(), ScriptError>
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)
source§fn load_script(
&mut self,
script: &[u8],
script_data: &ScriptData<'_>,
_: &mut APIProviders<Self>
) -> Result<Self::ScriptContext, ScriptError>
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.
source§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>
)
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
source§fn run_one_shot(
&mut self,
script: &[u8],
script_name: &str,
entity: Entity,
world: &mut World,
event: Self::ScriptEvent
) -> Result<(), ScriptError>
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
.source§fn register_with_app(app: &mut App, schedule: impl ScheduleLabel)
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. Read more
impl<A: FuncArgs + Send> Resource for RhaiScriptHost<A>
Auto Trait Implementations§
impl<A> Freeze for RhaiScriptHost<A>
impl<A> !RefUnwindSafe for RhaiScriptHost<A>
impl<A> Send for RhaiScriptHost<A>
impl<A> Sync for RhaiScriptHost<A>where
A: Sync,
impl<A> Unpin for RhaiScriptHost<A>where
A: Unpin,
impl<A> !UnwindSafe for RhaiScriptHost<A>
Blanket Implementations§
source§impl<T, U> AsBindGroupShaderType<U> for T
impl<T, U> AsBindGroupShaderType<U> for T
source§fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
fn as_bind_group_shader_type(&self, _images: &RenderAssets<Image>) -> U
Return the
T
ShaderType
for self
. When used in AsBindGroup
derives, it is safe to assume that all images in self
exist.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
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>
Convert
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<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>
Convert
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
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)
Convert
&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)
Convert
&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> DowncastSync for T
impl<T> DowncastSync 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 data from the given World
.