Installation

Cargo

First you need to install the crate by adding this entry to your Cargo.toml dependencies list:

bevy_mod_scripting = { version = "0.9.0", features = ["lua54"]}

Choose the language features you wish enabled and add them to the features block.

Bevy Plugin

The next step is to add the BMS plugin to your application, on top of any other extras you want included in your app:

app.add_plugins((
    LuaScriptingPlugin::default(),
    ScriptFunctionsPlugin
));

The above is how you'd setup BMS for Lua, if you want to use another language, simply use a corresponding plugin from the integration crate.

Language Features

Each language supported by BMS can be switched-on via feature flag as below:

Language	Feature Flag
Lua51	lua51
Lua52	lua54
Lua53	lua53
Lua54	lua54
Luajit	luajit
Luajit52	luajit52
Luau	luau
Rhai	rhai
Rune	rune

Extra Features

In order to fit as many use cases as possible, BMS allows you to disable a lot of its functionality.

By default all of the useful features are enabled, but you may disable them if you wish if you are only needing BMS for script lifecycle management, and want to populate the bindings yourself.

Feature	Description
core_functions	If enabled, will enable all core functions, i.e. bevy integrations which let you interact with Bevy via reflection
bevy_bindings	If enabled, populates the function registry with additiona automatically generated bevy bindings. This includes functions on `glam` and `bevy::ecs` types. These are useful but will slow down compilation considerably.
mlua_async	Enables `mlua/async`
mlua_serialize	Enables `mlua/serialize`
mlua_macros	Enables `mlua/macros`
unsafe_lua_modules	Allows loading unsafe modules via `require` in lua

Managing Scripts

Scripts live in the standard bevy assets directory. Loading a script means:

Parsing the script body
Creating or updating the resources which store script state
Assigning a name/id to the script so it can be referred to by the rest of the application.

Loading

BMS listens to ScriptAsset events and reacts accordingly. In order to load a script, all you need to do is request a handle to it via the asset server and store it somewhere.

Below is an example system which loads a script called assets/my_script.lua and stores the handle in a local system parameter:

fn load_script(server: Res<AssetServer>, mut handle: Local<Handle<ScriptAsset>>) {
    let handle_ = server.load::<ScriptAsset>("my_script.lua");
    *handle = handle_;
}

In practice you will likely store this handle in a resource or component, when your load all the scripts necessary for your application.

Unloading

Scripts are automatically unloaded when the asset is dropped. This means that if you have a handle to a script and it goes out of scope, the script will be unloaded.

This will delete references to the script and remove any internal handles to the asset. You will also need to clean up any handles to the asset you hold in your application in order for the asset to be unloaded.

Hot-loading scripts

To enable hot-loading of assets, you need to enable the necessary bevy features as normal see the bevy cheatbook for instructions.

Assuming that hot-reloading is enabled for your app, any changes to script assets will automatically be picked up and the scripts re-loaded.

File Extensions

Normally the set of supported extensions is pre-decided by each language plugin.

I.e. Lua supports ".lua" extensions and Rhai supports ".rhai" extensions.

Scripts are mapped to the corresponding language plugin based on these and so it's important to use them correctly.

If you would like to add more extensions you need to populate them via app.add_supported_script_extensions.

Advanced

Normally not necessary, but knowing these exist could be useful for more advanced use cases.

Manually (re)loading scripts

In order to manually re-load or load a script you can issue the CreateOrUpdateScript command:

CreateOrUpdateScript::<LuaScriptingPlugin>::new("my_script.lua".into(), "print(\"hello world from new script body\")".into(), asset_handle)

replace LuaScriptingPlugin with the scripting plugin you are using.

Manually Deleting scripts

In order to delete a previously loaded script, you will need to issue a DeleteScript command like so:

DeleteScript::<LuaScriptingPlugin>::new("my_script.lua".into())

replace LuaScriptingPlugin with the scripting plugin you are using.

Loading/Unloading timeframe

Scripts asset events are processed within the same frame they are issued. This means the moment an asset is loaded, it should be loaded and ready to use in the Update schedule. Similarly, the moment an asset is deleted, it should be unloaded and no longer usable in the Update schedule.

Attaching Scripts

Once you have scripts discovered and loaded, you'll want to run them.

At the moment BMS supports three methods of making scripts runnable:

Attaching them to entities via ScriptComponent's
Adding static scripts
Creating dynamic systems ⚗️ (see the script systems section)

And then sending script event's which trigger callbacks on the scripts.

Attaching scripts to entities

In order to attach a script and make it runnable simply add a ScriptComponent to an entity

    commands.entity(my_entity).insert(ScriptComponent::new(vec!["my_script.lua", "my_other_script.lua"]));

When this script is run the entity global will represent the entity the script is attached to. This allows you to interact with the entity in your script easilly.

Be wary of path separators, by default script ID's are derived from asset paths, which are platform dependent. Make sure to use `std::path::PathBuf` if you are targetting multiple platforms.

Making static scripts runnable

Some scripts do not require attaching to an entity. You can run these scripts by loading them first as you would with any other script, then either adding them at app level via add_static_script or by issuing a AddStaticScript command like so:

    commands.queue(AddStaticScript::new("my_static_script.lua"));

The script will then be run as any other script but without being attached to any entity. and as such the entity global will always represent an invalid entity.

Note: Internally these scripts are attached to a dummy entity and as such you can think of them as being attached to an entity with an id of 0.

Running Scripts

Scripts can run logic either when loaded or when triggered by an event. For example the script:

print("hello from load time")
function on_event(arg1)
    print("hello from event time")
    print(arg1)
end

Will print "hello from load time" when the script is loaded, and "hello from event time" when the script receives an event targeting the on_event callback with a receiver list including this script or entity.

In order to trigger on_event you need to first define a label, then send an event containing the label:


#[derive(Reflect)]
pub struct MyReflectType;

// define the label, you can define as many as you like here
callback_labels!(OnEvent => "on_event");

// trigger the event
fn send_event(mut writer: EventWriter<ScriptCallbackEvent>, mut allocator: ResMut<AppReflectAllocator>) {

    let allocator = allocator.write();
    let my_reflect_payload = ReflectReference::new_allocated(MyReflectType, &mut allocator);

    writer.send(ScriptCallbackEvent::new_for_all(
        OnEvent,
        vec![my_reflect_payload.into()],
    ));
}

Note the second argument is the payload we are sending with the event, in this case we are sending an arbitrary reflect type MyReflectType. This can be any type you like, as long as it implements Reflect.

Other variants of the ScriptValue enum are available for sending different types of data, such as ScriptValue::Integer for primtive, types.

Event Handlers

In order for the events you send to actually be picked up, you need to inject special systems into your application. These systems will listen for the events and trigger the appropriate callbacks on the scripts:

app.add_systems(Update, event_handler::<OnEvent, LuaScriptingPlugin>);

Note the system is parameterized by the label we defined earlier, and the scripting plugin we are using. You can add as many of these systems as you like.

The event handler will catch all events with the label OnEvent and trigger the on_event callback on all targeted scripts which have that callback defined.

In order to handle events in the same frame and not accidentally have events "spill over" into the next frame, you should make sure to order any systems which produce these events before the event handler systems.

Controlling Script Bindings

In this book we refer to anything accessible by a script, which allows it to communicate with your Rust code a binding (which in previous versions was more generically referred to as a script API).

The "binding" here being used as in: binding script code to rust code.

Namespaces

Namespaces are a way to group functions together, and are used to prevent naming conflicts. You can have multiple namespaces, and each namespace can have multiple functions.

Language implementations will also look for specific functions registered on your type first before looking at the generic ReflectReference namespace.

Dynamic Functions

Everything callable by scripts must first be registered in the dynamic function registry. Notably we do not make use of the normal bevy function registry to improve performance and usability. This means you cannot call just any function.

In order for a function to be callable by a script it must adhere to a few requirements:

Each argument must implement FromScript.
Each return type must implement IntoScript.
Each argument must also implement GetTypeDependencies
Each return type must also implement GetTypeDependencies

The into/from requirements allow us to convert these types to ScriptValue's, and each supported scripting language can then marshall these into the script.

Note these types are implemented for primitives, but if you want to interact with one of your Reflect implementing types, you will need to use one of Ref<T>, Mut<T> or Val<T> wrappers in place of &T, &mut T and T respectively.

These wrappers enable us to safely interact with bevy, and claim any necessary mutex'es on Resources, Components or Allocations.

The GetTypeDependencies, trait is simply a local trait alias for GetTypeRegistration with less strict type requirements. It allows us to register all the types necessary for the function calls, so that you don't have to register anything manually. If your type implements GetTypeRegistration you should not face any issues on this front.

Registering Script Functions

Registering functions can be done via the NamespaceBuilder like below:

    NamespaceBuilder::<ReflectReference>::new(&mut world)
        .register(
            "hello_world",
            |s: String| {
                println!(s)
            },
        );

    NamespaceBuilder::<GlobalNamespace>::new_unregistered(&mut world)
        .register(
            "hello_world2",
            |s: String| {
                println!(s)
            },
        );

This will allow you to call this function within lua like so:

some_type:hello_world("hi from method!");
hello_world2("hi from global!");

Note the new_unregistered call instead of new, this is because GlobalNamespace is not a Reflect type, and the new call also automatically registers the type in the reflection registry.

Macros

The above is a bit tedious, so instead you can use the script_bindings macro, which applies to impl blocks like so:

#[script_bindings("test_fn")]
impl TestStruct {
    /// My docs !!
    /// 
    /// Arguments:
    /// * `_self` - the first argument
    /// * `arg1` - the second argument
    /// Returns:
    /// * `return` - nothing
    fn test_fn(_self: Ref<TestStruct>, mut arg1: usize) {}
}


pub fn main() {
    let mut app = App::new();
    register_test_fn(app.world_mut())
}

Note the documentation will automatically be picked up and stored for the purposes of reflection and documentation generation, including argument/return type specific docs.

Context Arguments

Each script function call always receives an additional context argument: FunctionCallContext. You can opt-in to receive this argument in your own function definitions by adding it as the first argument.

The context contains requests from the caller to your function, such as "I am calling you from a 1-indexed array system, please convert the index first", This argument is only relevant if you're targeting multiple languages.

It also allows you to retrieve the world via FunctionCallContext::world().

You can use this as follows:

    NamespaceBuilder::<ReflectReference>::new(&mut world)
        .register(
            "hello_world",
            |ctx: FunctionCallContext, s: String| {
                let world = ctx.world()?;
                let should_use_0_indexing = ctx.convert_to_0_indexed;
                println!(should_use_0_indexing);
                println!(s)
                Ok(())
            },
        );

Generic Arguments

Sometimes you might want to be generic over the type of argument you're accepting, you can do so by accepting ScriptValue arguments like so:

    NamespaceBuilder::<ReflectReference>::new(&mut world)
        .register(
            "is_integer",
            |s: ScriptValue| {
                match s {
                    ScriptValue::Integer(i) => true,
                    _ => false
                }
            },
        );

You can treat return values similarly.

Fallible functions

Your script functions can return errors either by:

Returning Result<T: IntoScript, InteropError>
Returning ScriptValue and manually creating the ScriptValue::Error(into_interop_erorr.into()) variant.

Reserved Functions

There are a few reserved functions that you can override by registering them on a specific type:

Function Name	Description	Overridable?	Has Default Implementation?
get	a getter function, used for indexing into a type	❌	✅
set	a setter function, used for setting a value on a type	❌	✅
sub	a subtraction function, used for subtracting two values	✅	❌
add	an addition function, used for adding two values	✅	❌
mul	a multiplication function, used for multiplying two values	✅	❌
div	a division function, used for dividing two values	✅	❌
rem	a remainder function, used for getting the remainder of two values	✅	❌
neg	a negation function, used for negating a value	✅	❌
pow	a power function, used for raising a value to a power	✅	❌
eq	an equality function, used for checking if two values are equal	✅	❌
lt	a less than function, used for checking if a value is less than another	✅	❌
iter	an iterator function, used for iterating over a value	❌	✅
display_ref	a display function, used for displaying a reference to a value	❌	✅
display_value	a display function, used for displaying a mutable reference to a value	❌	✅

In this context overridable indicates whether language implementations will look for a specific function on your type before looking at the generic ReflectReference namespace. You can still remove the existing registration for these functions on the ReflectReference namespace if you want to replace them with your own implementation.

Note the ReflectReference namespace is special, in that functions defined on it, act like a fallback and hence apply to ALL references.

Modifying Script Contexts

You should be able to achieve what you need by registering script functions in most cases. However sometimes you might want to override the way contexts are loaded, or how the runtime is initialized.

This is possible using Context Initializers and Context Pre Handling Initializers as well as Runtime Initializers.

It is however always reccomened to use the dynamic script function registry whenever possible, as it is more flexible and easier to use. It also allows you to introspect available functions easier.

Context Initializers

For example, let's say you want to set a dynamic amount of globals in your script, depending on some setting in your app.

You could do this by customizing the scripting plugin:

let plugin = LuaScriptingPlugin::default().add_context_initializer(|script_id: &str, context: &mut Lua| {
    let globals = context.globals();
    for i in 0..10 {
        globals.set(i, i);
    }
    Ok(())
});

app.add_plugins(plugin)

The above will run every time the script is loaded or re-loaded and before it handles any callbacks.

Context Pre Handling Initializers

If you want to customize your context before every time it's about to handle events (and when it's loaded + reloaded), you can use Context Pre Handling Initializers:

let plugin = LuaScriptingPlugin::default().add_context_pre_handling_initializer(|script_id: &str, entity: Entity, context: &mut Lua| {
    let globals = context.globals();
    globals.set("script_name", script_id.to_owned());
    Ok(())
});

Runtime Initializers

Some scripting languages, have the concept of a runtime. This is a global object which is shared between all contexts. You can customize this object using Runtime Initializers:

let plugin = SomeScriptingPlugin::default().add_runtime_initializer(|runtime: &mut Runtime| {
    runtime.set_max_stack_size(1000);
    Ok(())
});

In the case of Lua, the runtime type is () i.e. This is because mlua does not have a separate runtime concept.

Accessing the World in Initializers

You can access the world in these initializers by using the thread local: ThreadWorldContainer:


let plugin = LuaScriptingPlugin::default();
plugin.add_context_initializer(|script_id: &str, context: &mut Lua| {
    let world = ThreadWorldContainer.try_get_world().unwrap();
    world.with_resource::<MyResource>(|res| println!("My resource: {:?}", res));
    Ok(())
});

Shared Contexts

By default BMS will create an individual script context, or sandbox, for each script that is run. This means that each script will have its own set of global variables and functions that are isolated from other scripts. However, sometimes this might not be desirable, if you aren't worried about scripts interfering with each other, or if you want to easilly share data between scripts. In these cases, you can use shared contexts.

Enabling Shared Contexts

You can enable shared contexts by configuring the relevant scripting plugin like so:

let mut plugin = LuaScriptingPlugin::default().enable_context_sharing();

app.add_plugins(plugin);

Context Loading Settings

All context loading settings are stored in a separate resource per scripting plugin namely: ContextLoadingSettings<Plugin>.

The settings are as follows:

loader - the load and unload strategy for contexts. Each scripting plugin will have a load and unload function which is hooked up through here
assigner - the strategy for assigning/unassigning contexts to scripts. This is used to determine how to assign a context to a script when it is run, and what to do with the context when the script is finished.
context_initializers - stores all context initializers for the plugin
context_pre_handling_initializers - stores all context pre-handling initializers for the plugin

More advanced applications might want to customize these settings to suit their needs.

Script ID mapping

Every script is currently identified by a unique ID.

ID's are derived from the script asset path for scripts loaded via the asset system.

By default this is an identity mapping, but you can override this by modifying the AssetPathToScriptIdMapper inside the ScriptAssetSettings resource before loading the script.

Be wary of path separators, by default script ID's are derived from asset paths, which are platform dependent. Make sure to use `std::path::PathBuf` if you are targetting multiple platforms.

Script Systems

Script systems are an experimental feature

It's possible within BMS to inject new systems from within scripts themselves.

Systems introduced by scripts can run in parallel to other systems, and can be freely inserted between any other system, including other script systems.

BMS also provides utilities for visualising schedules using dot graphs, allowing low-effort modding frameworks for game authors.

Schedules

Bevy doesn't support reflecting schedules, so BMS rolls it's own schedule registry resource: AppScheduleRegistry, which can be used to add any custom schedules you want to interact with. The default Bevy schedules will be pre-populated for you.

Once you've registered your schedule you will be able to interact with it in scripts like below:

local update_schedule = world.get_schedule_by_name("Update")
local systems = update:systems()
local system_with_name = update:get_system_by_name("my_system")

Inserting Systems

To insert a system you will need to use the system_builder global function like below:

local system = system_builder("my_system", script_id)
    :exclusive()
    :after(some_other_system)
    :before(another_system)

This will let you call world.add_system like so:

world.add_system(update_schedule,system)

If your event handler running the script is running in a certain schedule, that schedule will be temporarilly removed by Bevy. Meaning you won't be able to modify it from within the script in-flight.

Parameters

The system builder allows script authors to parameterise systems, using resource and query functions. The order in which those functions are called, will define the order in which arguments will be provided to the specified script callback.

For example:

system_builder("my_system")
    :query(
        world.query()
            :component(ComponentA)
            :component(ComponentB)
            :with(ComponentC)
            :without(ComponentD)
    )
    :resource(ResourceA)

will create a system which calls the specified callback my_system with 2 arguments:

The ScriptQueryResult for the first query
- With components access to ComponentA and ComponentB
The ReflectReference to ResourceA

Exclusive systems

An exclusive system can be created using the exclusive function call on the system builder.

This allows the system to access everything as in a normal event handler.

Non-exclusive systems, will only be able to access the set of components and resources as parameterized when building the system. This is why we can run the system in parallel to other non-overlapping systems.

Exclusive systems on the other hand, cannot run in parallel.

Callback

The system injected will be similar to an event handler, however it will only trigger the specified script, and without any entity, in the first example you'd see the following lua callback:

function my_system()
    print("I am a dynamic system")
end

get triggered every update.

Examples

In the future we hope to embedd live WASM code examples into the documentation, for now the best source of example scripts will be our regression test suite available in all supported languages in our github repository.

For rust examples see this folder.

Scripting Reference

This part of the book covers the user-facing API of the scripting languages supported by BMS. This will be where you will want to forward your script users to get started with scripting in BMS.

If you are a modder, welcome! 👋, apologies for the rust-centricity of this guide, we are working on it!

Globals

Scripts will have access to a few global variables in most callbacks:

world: a static reference to the world, with all sorts of functions available
entity: the entity the script is attached to, not available on load/unload callbacks, and in dynamic system callbacks.
script_id: the ID of the current script

Constructing Arbitrary Types

When interfacing with bevy, we do this via reflection. While the generated bindings do not cover constructors for every single type that bevy or other libraries provide, reflection allows us to construct some (not all types implement FromReflect) types from dynamic structs.

BMS exposes this ability to all script writers via the construct global function.

Structs

The following struct:

pub struct MyStruct {
    pub my_field: String
}

can be constructed from lua like so:

local MyStruct = types.MyStruct
local concrete_my_struct = construct(MyStruct, {
    my_field = "hello"
})

Tuple Structs

The following tuple struct:


pub struct MyTupleStruct(pub String);

can be constructed like so:


local MyTupleStruct = types.MyTupleStruct
local concrete_my_tuple_struct = construct(MyTupleStruct, {
    _1 = "hello"
})

Enums

The following enum:

pub enum MyEnum {
    VariantA {
        field: String
    },
    VariantB
}

can be constructed like so:


local MyEnum = types.MyEnum
local variantA = construct(MyEnum, {
    variant = "VariantA",
    field = "hello"
})
local variantB = construct(MyEnum, {
    variant = "VariantB"
})

When working with enums you can also figure out the variant at runtime using variant_name:

if my_enum:variant_name() == "VariantA" then
    print(my_enum.field)
end

Core Bindings

This is an automatically generated file, you'll find links to the contents below

Section	Contents
`Types`	Describes all available binding types
`Global Functions`	Documents all the global functions present in the bindings
`Globals`	Documents all global variables present in the bindings

Globals

Global Values

Global values that are accessible anywhere inside scripts. You should avoid naming conflicts with these and trying to overwrite or edit them.

Instances

Instances containing actual accessible values.

Instance	Type
`types`	HashMap<String, ScriptTypeRegistration \| ScriptComponentRegistration \| ScriptResourceRegistration>
`entity`	Entity
`world`	World
`script_id`	String

Static Instances

Static type references, existing for the purpose of typed static function calls.

Instance	Type
`AtomicI16`	AtomicI16
`Dir3A`	Dir3A
`Outline`	Outline
`Monitor`	Monitor
`FogFalloff`	FogFalloff
`ClusterFarZMode`	ClusterFarZMode
`Interaction`	Interaction
`Hwba`	Hwba
`Mesh`	Mesh
`AlphaMode2d`	AlphaMode2d
`VolumetricLight`	VolumetricLight
`Frustum`	Frustum
`ClusterZConfig`	ClusterZConfig
`AabbGizmoConfigGroup`	AabbGizmoConfigGroup
`AnimationTransitions`	AnimationTransitions
`URect`	URect
`ComputedNode`	ComputedNode
`Val`	Val
`ScriptValue`	ScriptValue
`TextLayoutInfo`	TextLayoutInfo
`AssetPath`	AssetPath
`NonZeroU16`	NonZeroU16
`U64Vec2`	U64Vec2
`TargetCamera`	TargetCamera
`ForceTouch`	ForceTouch
`PickingPlugin`	PickingPlugin
`BoundingSphereCast`	BoundingSphereCast
`GizmoLineStyle`	GizmoLineStyle
`AtomicBool`	AtomicBool
`Namespace`	Namespace
`TextLayout`	TextLayout
`Aabb`	Aabb
`Timer`	Timer
`u8`	u8
`TextNodeFlags`	TextNodeFlags
`Line2d`	Line2d
`InternalWindowState`	InternalWindowState
`i64`	i64
`ThreadedAnimationGraph`	ThreadedAnimationGraph
`Arc`	Arc
`Identifier`	Identifier
`OnInsert`	OnInsert
`ContentSize`	ContentSize
`AnimationGraphHandle`	AnimationGraphHandle
`Triangle2d`	Triangle2d
`TextColor`	TextColor
`CursorIcon`	CursorIcon
`Circle`	Circle
`WindowDestroyed`	WindowDestroyed
`JustifySelf`	JustifySelf
`UvChannel`	UvChannel
`CursorOptions`	CursorOptions
`Rect`	Rect
`WindowCloseRequested`	WindowCloseRequested
`PlaybackSettings`	PlaybackSettings
`WindowResizeConstraints`	WindowResizeConstraints
`RayCast3d`	RayCast3d
`WindowResized`	WindowResized
`PointerLocation`	PointerLocation
`EaseFunction`	EaseFunction
`MotionVectorPrepass`	MotionVectorPrepass
`BloomCompositeMode`	BloomCompositeMode
`u128`	u128
`Triangle3d`	Triangle3d
`SpotLight`	SpotLight
`PositionType`	PositionType
`I64Vec2`	I64Vec2
`FunctionReturnInfo`	FunctionReturnInfo
`HierarchyEvent`	HierarchyEvent
`Ellipse`	Ellipse
`ColorMaterial`	ColorMaterial
`PanGesture`	PanGesture
`BoundingCircle`	BoundingCircle
`Key`	Key
`IVec4`	IVec4
`char`	char
`OverflowClipMargin`	OverflowClipMargin
`Hsla`	Hsla
`NoFrustumCulling`	NoFrustumCulling
`GizmoLineJoint`	GizmoLineJoint
`Virtual`	Virtual
`TextFont`	TextFont
`ConicalFrustum`	ConicalFrustum
`Dir3`	Dir3
`Rectangle`	Rectangle
`Mat2`	Mat2
`GamepadInput`	GamepadInput
`Window`	Window
`ButtonAxisSettings`	ButtonAxisSettings
`Camera3d`	Camera3d
`EnvironmentMapLight`	EnvironmentMapLight
`SmolStr`	SmolStr
`PickingBehavior`	PickingBehavior
`Cylinder`	Cylinder
`i128`	i128
`Camera2d`	Camera2d
`RayId`	RayId
`Exposure`	Exposure
`DVec4`	DVec4
`ActiveAnimation`	ActiveAnimation
`GridAutoFlow`	GridAutoFlow
`BorderRect`	BorderRect
`usize`	usize
`OrthographicProjection`	OrthographicProjection
`U64Vec4`	U64Vec4
`u32`	u32
`SliceScaleMode`	SliceScaleMode
`AspectRatio`	AspectRatio
`GamepadRumbleIntensity`	GamepadRumbleIntensity
`Affine2`	Affine2
`GltfSceneExtras`	GltfSceneExtras
`DMat3`	DMat3
`CascadesFrusta`	CascadesFrusta
`Button`	Button
`BoundingSphere`	BoundingSphere
`SpatialScale`	SpatialScale
`SpatialListener`	SpatialListener
`FontSmoothing`	FontSmoothing
`U64Vec3`	U64Vec3
`BVec4`	BVec4
`PerspectiveProjection`	PerspectiveProjection
`WindowTheme`	WindowTheme
`ImageNodeSize`	ImageNodeSize
`BVec4A`	BVec4A
`AnimationTargetId`	AnimationTargetId
`Range`	Range
`GridTrack`	GridTrack
`DAffine3`	DAffine3
`CompositeAlphaMode`	CompositeAlphaMode
`WindowEvent`	WindowEvent
`i8`	i8
`EulerRot`	EulerRot
`ViewVisibility`	ViewVisibility
`FunctionInfo`	FunctionInfo
`TextureSlicer`	TextureSlicer
`FlexDirection`	FlexDirection
`IVec3`	IVec3
`TemporalJitter`	TemporalJitter
`GltfMaterialName`	GltfMaterialName
`CubemapFrusta`	CubemapFrusta
`AxisSettings`	AxisSettings
`PointLight`	PointLight
`ScrollPosition`	ScrollPosition
`ThreadedAnimationGraphs`	ThreadedAnimationGraphs
`Smaa`	Smaa
`MeshMorphWeights`	MeshMorphWeights
`AtomicI64`	AtomicI64
`ScriptTypeRegistration`	ScriptTypeRegistration
`ReflectSystem`	ReflectSystem
`Color`	Color
`FunctionArgInfo`	FunctionArgInfo
`EntityHash`	EntityHash
`Instant`	Instant
`SkinnedMesh`	SkinnedMesh
`PointerId`	PointerId
`u64`	u64
`Mat3`	Mat3
`FloatOrd`	FloatOrd
`KeyboardFocusLost`	KeyboardFocusLost
`AccumulatedMouseMotion`	AccumulatedMouseMotion
`Sensitivity`	Sensitivity
`JustifyContent`	JustifyContent
`MouseButtonInput`	MouseButtonInput
`AlignItems`	AlignItems
`PointerInputPlugin`	PointerInputPlugin
`Parent`	Parent
`BloomPrefilter`	BloomPrefilter
`ColorGradingSection`	ColorGradingSection
`MonitorSelection`	MonitorSelection
`Tonemapping`	Tonemapping
`RelativeCursorPosition`	RelativeCursorPosition
`Projection`	Projection
`TextEntity`	TextEntity
`AlignSelf`	AlignSelf
`ButtonSettings`	ButtonSettings
`AmbientLight`	AmbientLight
`Children`	Children
`ComponentTicks`	ComponentTicks
`RenderTarget`	RenderTarget
`SmaaPreset`	SmaaPreset
`Label`	Label
`Sphere`	Sphere
`u16`	u16
`SystemIdMarker`	SystemIdMarker
`DistanceFog`	DistanceFog
`CustomCursor`	CustomCursor
`Tetrahedron`	Tetrahedron
`BoundingCircleCast`	BoundingCircleCast
`SubCameraView`	SubCameraView
`ReflectReference`	ReflectReference
`Real`	Real
`Screenshot`	Screenshot
`CascadeShadowConfig`	CascadeShadowConfig
`Name`	Name
`Rot2`	Rot2
`ZIndex`	ZIndex
`PointerInteraction`	PointerInteraction
`CalculatedClip`	CalculatedClip
`VolumetricFog`	VolumetricFog
`Cone`	Cone
`MaxTrackSizingFunction`	MaxTrackSizingFunction
`f32`	f32
`ClusterConfig`	ClusterConfig
`GlobalsUniform`	GlobalsUniform
`ImageNode`	ImageNode
`WindowClosing`	WindowClosing
`MouseScrollUnit`	MouseScrollUnit
`GizmoConfigStore`	GizmoConfigStore
`RenderAssetUsages`	RenderAssetUsages
`Overflow`	Overflow
`AtomicU64`	AtomicU64
`DirectionalLight`	DirectionalLight
`ReflectSchedule`	ReflectSchedule
`WindowClosed`	WindowClosed
`Vec4`	Vec4
`Tick`	Tick
`Ray2d`	Ray2d
`Quat`	Quat
`PlaybackMode`	PlaybackMode
`StandardMaterial`	StandardMaterial
`PickingInteraction`	PickingInteraction
`Ime`	Ime
`GltfExtras`	GltfExtras
`Uuid`	Uuid
`LineBreak`	LineBreak
`ScreenSpaceReflections`	ScreenSpaceReflections
`InteropError`	InteropError
`Aabb3d`	Aabb3d
`DebandDither`	DebandDither
`PointerPress`	PointerPress
`KeyCode`	KeyCode
`Vec3`	Vec3
`DQuat`	DQuat
`AtomicU8`	AtomicU8
`BVec3A`	BVec3A
`TouchInput`	TouchInput
`CubemapVisibleEntities`	CubemapVisibleEntities
`VideoMode`	VideoMode
`GamepadAxis`	GamepadAxis
`ButtonState`	ButtonState
`AtomicU16`	AtomicU16
`Text2d`	Text2d
`OrderIndependentTransparencySettings`	OrderIndependentTransparencySettings
`Rhombus`	Rhombus
`CompassQuadrant`	CompassQuadrant
`Gamepad`	Gamepad
`RayCast2d`	RayCast2d
`Node`	Node
`FocusPolicy`	FocusPolicy
`CircularSector`	CircularSector
`RangeFull`	RangeFull
`ScreenshotCaptured`	ScreenshotCaptured
`Camera3dDepthLoadOp`	Camera3dDepthLoadOp
`Cascades`	Cascades
`TextBounds`	TextBounds
`DiGraph`	DiGraph
`DoubleTapGesture`	DoubleTapGesture
`GlyphAtlasInfo`	GlyphAtlasInfo
`CursorLeft`	CursorLeft
`WindowOccluded`	WindowOccluded
`GamepadAxisChangedEvent`	GamepadAxisChangedEvent
`MouseWheel`	MouseWheel
`PinchGesture`	PinchGesture
`DeferredPrepass`	DeferredPrepass
`FlexWrap`	FlexWrap
`AlignContent`	AlignContent
`Indices`	Indices
`InfinitePlane3d`	InfinitePlane3d
`IRect`	IRect
`RenderLayers`	RenderLayers
`PositionedGlyph`	PositionedGlyph
`UiAntiAlias`	UiAntiAlias
`GamepadSettings`	GamepadSettings
`IVec2`	IVec2
`Cow`	Cow
`BackgroundColor`	BackgroundColor
`RequestRedraw`	RequestRedraw
`isize`	isize
`Isometry3d`	Isometry3d
`ScriptResourceRegistration`	ScriptResourceRegistration
`DirectionalLightShadowMap`	DirectionalLightShadowMap
`AnimationEvent`	AnimationEvent
`Isometry2d`	Isometry2d
`JustifyText`	JustifyText
`Affine3A`	Affine3A
`DMat2`	DMat2
`Sprite`	Sprite
`DynamicSceneRoot`	DynamicSceneRoot
`CircularSegment`	CircularSegment
`OnReplace`	OnReplace
`GamepadConnection`	GamepadConnection
`AtomicUsize`	AtomicUsize
`Mesh3d`	Mesh3d
`Interval`	Interval
`UVec4`	UVec4
`UiRect`	UiRect
`TouchPhase`	TouchPhase
`Torus`	Torus
`DynamicScriptFunctionMut`	DynamicFunctionMut
`RepeatAnimation`	RepeatAnimation
`VisibleMeshEntities`	VisibleMeshEntities
`String`	String
`WindowBackendScaleFactorChanged`	WindowBackendScaleFactorChanged
`Camera`	Camera
`TypeId`	TypeId
`OnRemove`	OnRemove
`TextureAtlas`	TextureAtlas
`AtomicU32`	AtomicU32
`InheritedVisibility`	InheritedVisibility
`ScreenSpaceTransmissionQuality`	ScreenSpaceTransmissionQuality
`GamepadConnectionEvent`	GamepadConnectionEvent
`Segment2d`	Segment2d
`CursorGrabMode`	CursorGrabMode
`ContrastAdaptiveSharpening`	ContrastAdaptiveSharpening
`WindowScaleFactorChanged`	WindowScaleFactorChanged
`RemovedComponentEntity`	RemovedComponentEntity
`NotShadowCaster`	NotShadowCaster
`ChromaticAberration`	ChromaticAberration
`VisibleEntities`	VisibleEntities
`Fixed`	Fixed
`Xyza`	Xyza
`ScriptSystemBuilder`	ScriptSystemBuilder
`SystemCursorIcon`	SystemCursorIcon
`Cascade`	Cascade
`i32`	i32
`TextureAtlasLayout`	TextureAtlasLayout
`ParallaxMappingMethod`	ParallaxMappingMethod
`RegularPolygon`	RegularPolygon
`ShadowFilteringMethod`	ShadowFilteringMethod
`WindowRef`	WindowRef
`GridTrackRepetition`	GridTrackRepetition
`AccumulatedMouseScroll`	AccumulatedMouseScroll
`SpriteImageMode`	SpriteImageMode
`OverflowClipBox`	OverflowClipBox
`WindowFocused`	WindowFocused
`Line3d`	Line3d
`BVec3`	BVec3
`TextSpan`	TextSpan
`I64Vec3`	I64Vec3
`NodeImageMode`	NodeImageMode
`AnimationPlayer`	AnimationPlayer
`OpaqueRendererMethod`	OpaqueRendererMethod
`ResolvedBorderRadius`	ResolvedBorderRadius
`AlphaMode`	AlphaMode
`DepthOfField`	DepthOfField
`HitData`	HitData
`Entity`	Entity
`IrradianceVolume`	IrradianceVolume
`OnAdd`	OnAdd
`Focus`	Focus
`AnimationGraph`	AnimationGraph
`GamepadButton`	GamepadButton
`Oklaba`	Oklaba
`AabbCast2d`	AabbCast2d
`Dir2`	Dir2
`Segment3d`	Segment3d
`CompassOctant`	CompassOctant
`ComputedTextBlock`	ComputedTextBlock
`GlobalTransform`	GlobalTransform
`UiBoxShadowSamples`	UiBoxShadowSamples
`Vec2`	Vec2
`RotationGesture`	RotationGesture
`RawGamepadAxisChangedEvent`	RawGamepadAxisChangedEvent
`NativeKeyCode`	NativeKeyCode
`RawGamepadButtonChangedEvent`	RawGamepadButtonChangedEvent
`AnimationEventTarget`	AnimationEventTarget
`ReflectableScheduleLabel`	ReflectableScheduleLabel
`ColorGradingGlobal`	ColorGradingGlobal
`MouseButton`	MouseButton
`AabbCast3d`	AabbCast3d
`DVec2`	DVec2
`Duration`	Duration
`DAffine2`	DAffine2
`PrimaryWindow`	PrimaryWindow
`MipBias`	MipBias
`AppLifecycle`	AppLifecycle
`Fxaa`	Fxaa
`UVec2`	UVec2
`LightGizmoColor`	LightGizmoColor
`Vec3A`	Vec3A
`WindowLevel`	WindowLevel
`MorphWeights`	MorphWeights
`LinearRgba`	LinearRgba
`bool`	bool
`Ray3d`	Ray3d
`ScreenSpaceAmbientOcclusionQualityLevel`	ScreenSpaceAmbientOcclusionQualityLevel
`ScriptQueryResult`	ScriptQueryResult
`Oklcha`	Oklcha
`Aabb2d`	Aabb2d
`Capsule2d`	Capsule2d
`ScalingMode`	ScalingMode
`Anchor`	Anchor
`GizmoConfig`	GizmoConfig
`ColorGrading`	ColorGrading
`FunctionCallContext`	FunctionCallContext
`Display`	Display
`DVec3`	DVec3
`Stopwatch`	Stopwatch
`Capsule3d`	Capsule3d
`DMat4`	DMat4
`GridPlacement`	GridPlacement
`WindowCreated`	WindowCreated
`ScreenSpaceAmbientOcclusion`	ScreenSpaceAmbientOcclusion
`NonZeroU32`	NonZeroU32
`UVec3`	UVec3
`ScriptComponentRegistration`	ScriptComponentRegistration
`AtomicI32`	AtomicI32
`DepthOfFieldMode`	DepthOfFieldMode
`Text`	Text
`Mat3A`	Mat3A
`BorderColor`	BorderColor
`AtomicI8`	AtomicI8
`WindowMoved`	WindowMoved
`PresentMode`	PresentMode
`GamepadRumbleRequest`	GamepadRumbleRequest
`PathBuf`	PathBuf
`Lcha`	Lcha
`GamepadButtonChangedEvent`	GamepadButtonChangedEvent
`Bloom`	Bloom
`GlobalVolume`	GlobalVolume
`MinTrackSizingFunction`	MinTrackSizingFunction
`CascadesVisibleEntities`	CascadesVisibleEntities
`WindowPosition`	WindowPosition
`AtomicIsize`	AtomicIsize
`MouseMotion`	MouseMotion
`EnabledButtons`	EnabledButtons
`f64`	f64
`DefaultSpatialScale`	DefaultSpatialScale
`ScriptQueryBuilder`	ScriptQueryBuilder
`ClearColorConfig`	ClearColorConfig
`Mesh2d`	Mesh2d
`CameraMainTextureUsages`	CameraMainTextureUsages
`Annulus`	Annulus
`I64Vec4`	I64Vec4
`DepthPrepass`	DepthPrepass
`AnimationTarget`	AnimationTarget
`CursorMoved`	CursorMoved
`i16`	i16
`Affine3`	Affine3
`Camera3dDepthTextureUsage`	Camera3dDepthTextureUsage
`Msaa`	Msaa
`RawGamepadEvent`	RawGamepadEvent
`RepeatedGridTrack`	RepeatedGridTrack
`Visibility`	Visibility
`WindowThemeChanged`	WindowThemeChanged
`GlyphAtlasLocation`	GlyphAtlasLocation
`LightProbe`	LightProbe
`AnimationTransition`	AnimationTransition
`CursorEntered`	CursorEntered
`DefaultOpaqueRendererMethod`	DefaultOpaqueRendererMethod
`ManualTextureViewHandle`	ManualTextureViewHandle
`GamepadEvent`	GamepadEvent
`BorderRadius`	BorderRadius
`Volume`	Volume
`ShaderStorageBuffer`	ShaderStorageBuffer
`FileDragAndDrop`	FileDragAndDrop
`Viewport`	Viewport
`SpriteSource`	SpriteSource
`KeyboardInput`	KeyboardInput
`WindowResolution`	WindowResolution
`Plane3d`	Plane3d
`TimerMode`	TimerMode
`OverflowAxis`	OverflowAxis
`Transform`	Transform
`Srgba`	Srgba
`NodeIndex`	NodeIndex
`ComponentId`	ComponentId
`Laba`	Laba
`LightGizmoConfigGroup`	LightGizmoConfigGroup
`NotShadowReceiver`	NotShadowReceiver
`Cuboid`	Cuboid
`Plane2d`	Plane2d
`GltfMaterialExtras`	GltfMaterialExtras
`PointLightShadowMap`	PointLightShadowMap
`TimedAnimationEvent`	TimedAnimationEvent
`ClearColor`	ClearColor
`GltfMeshExtras`	GltfMeshExtras
`VisibilityRange`	VisibilityRange
`GamepadButtonStateChangedEvent`	GamepadButtonStateChangedEvent
`BVec2`	BVec2
`NonZeroI16`	NonZeroI16
`Arc2d`	Arc2d
`AssetIndex`	AssetIndex
`Mat4`	Mat4
`Hsva`	Hsva
`WindowMode`	WindowMode
`JustifyItems`	JustifyItems
`NativeKey`	NativeKey
`SyncToRenderWorld`	SyncToRenderWorld
`UiScale`	UiScale
`NormalPrepass`	NormalPrepass
`Image`	Image
`CameraRenderGraph`	CameraRenderGraph
`AnimationClip`	AnimationClip
`SceneRoot`	SceneRoot

Functions

Non-Associated Functions

Global functions that are not associated with any type and callable from anywhere in the script.

For function details and documentation, click on the function link.

Function	Summary
construct	Attempts to construct the given type, given an arbitrary map of values.
system_builder	Creates a new script system builder, which can be used to add new systems to the world.

`construct`

This function is impure, it might potentially try to access anything in the world. If you are using it in the context of a script system, it might cause access errors.

> Attempts to construct the given type, given an arbitrary map of values.

Type	Summary
`World`	The ECS world containing all Components, Resources and Systems. Main point of interaction with a Bev...
`ReflectReference`	A reference to an arbitrary reflected instance. The reference can point to either the ECS, or to ...
`ScriptComponentRegistration`	A reference to a component type's reflection registration. In general think of this as a handle t...
`ScriptQueryBuilder`	The query builder is used to build ECS queries which retrieve spefific components filtered by speci...
`ScriptQueryResult`	A result from a query.
`ScriptResourceRegistration`	A reference to a resource type's reflection registration. In general think of this as a handle to...
`ScriptTypeRegistration`	A reference to a type which is not a `Resource` or `Component`. In general think of this as a han...
`ScriptSystemBuilder`	A builder for systems living in scripts
`ReflectSchedule`	A reflectable schedule.
`ReflectSystem`	A reflectable system.
`Name`	Component used to identify an entity. Stores a hash for faster comparisons. The hash is eagerly r...
`ComponentId`	A value which uniquely identifies the type of a [`Component`] or [`Resource`] within a [`World`]. Each time a new `Component` type is registered within a `World` using e.g. [`World::register_component`]...
`ComponentTicks`	Records when a component or resource was added and when it was last mutably dereferenced (or added)...
`Tick`	A value that tracks when a system ran relative to other systems. This is used to power change dete...
`Entity`	Lightweight identifier of an [entity](crate::entity). The identifier is implemented using a [gene...
`EntityHash`	A [`BuildHasher`] that results in a [`EntityHasher`].
`Identifier`	A unified identifier for all entity and similar IDs. Has the same size as a `u64` integer, but th...
`RemovedComponentEntity`	Wrapper around [`Entity`] for [`RemovedComponents`]. Internally, `RemovedComponents` uses these as...
`Children`	Contains references to the child entities of this entity. Each child must contain a [`Parent`] component that points back to this entity. This component rarely needs to be created manually, consider using higher level utilities like [`BuildChildren::with_children`]...
`Parent`	Holds a reference to the parent entity of this entity. This component should only be present on en...
`HierarchyEvent`	An [`Event`] that is fired whenever there is a change in the world's hierarchy. [`Event`]: bevy_ecs::event::Event
`ButtonState`	The current "press" state of an element
`AxisSettings`	Settings for a [`GamepadAxis`]. It is used inside the [`GamepadSettings`] to define the sensitivi...
`ButtonAxisSettings`	Settings for a [`GamepadButton`]. It is used inside the [`GamepadSettings`] to define the sensiti...
`ButtonSettings`	Manages settings for gamepad buttons. It is used inside [`GamepadSettings`] to define the threshold for a [`GamepadButton`]...
`Gamepad`	Stores a connected gamepad's metadata such as the name and its [`GamepadButton`] and [`GamepadAxis`...
`GamepadAxis`	Represents gamepad input types that are mapped in the range [-1.0, 1.0] ## Usage This is used to determine which axis has changed its value when receiving a gamepad axis event. It is also used in the [`Gamepad`]...
`GamepadAxisChangedEvent`	[`GamepadAxis`] event triggered by an analog state change
`GamepadButton`	Represents gamepad input types that are mapped in the range [0.0, 1.0]. ## Usage This is used to determine which button has changed its value when receiving gamepad button events It is also used in the [`Gamepad`]...
`GamepadButtonChangedEvent`	[`GamepadButton`] event triggered by an analog state change
`GamepadButtonStateChangedEvent`	[`GamepadButton`] event triggered by a digital state change
`GamepadConnection`	The connection status of a gamepad.
`GamepadConnectionEvent`	A Gamepad connection event. Created when a connection to a gamepad is established and when a gamep...
`GamepadEvent`	A gamepad event. This event type is used over the [`GamepadConnectionEvent`], [`GamepadButtonChangedEvent`...
`GamepadInput`	Encapsulation over [`GamepadAxis`] and [`GamepadButton`]
`GamepadRumbleIntensity`	The intensity at which a gamepad's force-feedback motors may rumble.
`GamepadRumbleRequest`	An event that controls force-feedback rumbling of a [`Gamepad`] [`entity`](Entity). # Notes Doe...
`GamepadSettings`	Gamepad settings component. ## Usage It is used to create a `bevy` component that stores the se...
`RawGamepadAxisChangedEvent`	[`GamepadAxis`] changed event unfiltered by [`GamepadSettings`]
`RawGamepadButtonChangedEvent`	[`GamepadButton`] changed event unfiltered by [`GamepadSettings`]

Bevy Scripting