Struct ScriptFnRegistry 

pub struct ScriptFnRegistry { /* private fields */ }

The app-wide registration channel every script host drains.

Order is preserved and meaningful: a later function of the same namespace and name shadows an earlier one, because that is what each engine does when the same name is registered twice.

Implementations

impl ScriptFnRegistry

pub fn push(&mut self, f: ScriptFn)

Append a function.

pub fn push_prelude(&mut self, prelude: ScriptPrelude)

Append a plugin’s language source.

Two plugins may ship source for the same namespace, and both are kept: one plugin registers the functions and another wraps them, which is a composition the registry has no business breaking. It is worth saying out loud, because the two sources are compiled into the same program and a name written in both is a compile error the app author did not write.

pub fn fns(&self) -> &[ScriptFn]

Every registered function, in registration order.

pub fn preludes(&self) -> &[ScriptPrelude]

Every registered language source, in registration order.

pub fn preludes_for_lang(&self, lang: &str) -> Vec<&ScriptPrelude>

The sources lang is to compile ahead of the app’s program, in registration order.

pub fn seal(&mut self)

Close the channel. Every host has bound what it is going to bind.

pub fn is_sealed(&self) -> bool

Whether the channel is closed.

Trait Implementations

impl Component for ScriptFnRegistry

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 Debug for ScriptFnRegistry

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ScriptFnRegistry

fn default() -> ScriptFnRegistry

Returns the “default value” for a type.

impl Resource for ScriptFnRegistry

where Self: Send + Sync + 'static,