Expand description
Core functionality for the bevy_mod_scripting framework.
Contains language agnostic systems and types for handling scripting in bevy.
Modules§
- asset
- Systems and resources for handling script assets and events
- bindings
- Abstractions to help with creating bindings between bevy and scripting languages.
- commands
- Commands for creating, updating and deleting scripts
- context
- Traits and types for managing script contexts.
- docgen
- Documentation generation for scripting languages.
- error
- Errors that can occur when interacting with the scripting system
- event
- Event handlers and event types for scripting.
- handler
- Contains the logic for handling script callback events
- reflection_
extensions - Various utility functions for working with reflection types.
- runtime
- “Runtime” here refers to the execution evironment of scripts. This might be the VM executing bytecode or the interpreter executing source code.
The important thing is that there is only one runtime which is used to execute all scripts of a particular type or
context
. - script
- Script related types, functions and components
Macros§
- callback_
labels - Creates a set of callback labels
- downcast_
into_ value - Downcasts a reference into a value of a given type or returns an error if the downcast fails.
- match_
by_ type - a utility for matching types by their
std::any::TypeId
- no_
type_ dependencies - A macro for implementing
GetTypeDependencies
for types with no type dependencies. - self_
type_ dependency_ only - A macro for implementing
GetTypeDependencies
for types that only depend on themselves. - with_
access_ read - A macro for claiming access to a value for reading
- with_
access_ write - A macro for claiming access to a value for writing
- with_
global_ access - A macro for claiming global access
Structs§
- Scripting
Plugin - Bevy plugin enabling scripting within the bevy mod scripting framework
Enums§
- Scripting
System Set - Labels for various BMS systems
Traits§
- AddRuntime
Initializer - Trait for adding a runtime initializer to an app
- Configure
Script Asset Settings - Trait for adding a supported extension to the script asset settings.
- Configure
Script Plugin - Utility trait for configuring all scripting plugins.
- Into
Script Plugin Params - Types which act like scripting plugins, by selecting a context and runtime Each individual combination of context and runtime has specific infrastructure built for it and does not interact with other scripting plugins
- Manage
Static Scripts - Trait for adding static scripts to an app