Struct FunctionIndex 

pub struct FunctionIndex { /* private fields */ }

Index of component methods derived from Bevy’s FunctionRegistry.

This is used by WIT generation and by the host runtime to resolve dynamic method calls.

Implementations

impl FunctionIndex

pub fn build( type_registry: &AppTypeRegistry, function_registry: &AppFunctionRegistry, ) -> Self

Build a fresh index from the app’s type and function registries.

Example

let index = FunctionIndex::build(&type_registry, &function_registry);

pub fn components(&self) -> impl Iterator<Item = &str>

Iterate over all exported component type paths.

pub fn methods_for<'a>( &'a self, type_path: &str, ) -> impl Iterator<Item = &'a FunctionEntry>

Iterate over all methods for a component type path.

pub fn get(&self, type_path: &str, method: &str) -> Option<&FunctionEntry>

Lookup a specific method entry.

pub fn invoke( &self, type_path: &str, method: &str, target: MethodTarget<'_>, params: &[u8], type_registry: &AppTypeRegistry, codec: &CodecResource, ) -> Result<Vec<u8>>

Invoke a reflected method using JSON-encoded arguments.

params_json must be a JSON array string. The return value is JSON.

Example

let out = index.invoke(
    Health::type_path(),
    "heal",
    MethodTarget::Write(&mut health),
    "[5.0]",
    &type_registry,
)?;

Trait Implementations

impl Component for FunctionIndex

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for FunctionIndex

fn default() -> FunctionIndex

Returns the “default value” for a type.

impl Resource for FunctionIndex

where Self: Send + Sync + 'static,