Struct StageHookScripts 

pub struct StageHookScripts(pub HashMap<String, Arc<HookScript>>);

Compiled stage-hook scripts for an agent, keyed by the script path the blueprint wrote (issue #260).

Populated once at spawn by the CLI, which resolves blueprint-dir-relative paths and compile-checks the files - the same lifecycle ContextWindow::region_scripts has, and for the same reason: a broken script must fail the spawn, not the run.

The component is absent entirely on an agent whose blueprint declares no hooks, so the hook systems’ queries skip it and nothing about the scripting engine is touched.

Tuple Fields

0: HashMap<String, Arc<HookScript>>

Implementations

impl StageHookScripts

pub fn script_for(&self, stage: &Stage, hook: &str) -> Option<Arc<HookScript>>

The compiled script backing hook for this stage, when the stage declares one and it is on file.

Returns None rather than erroring on a miss: spawn already refused a blueprint whose script was unreadable or did not define what it was named for, so a miss here means the stage simply has no such hook.

Trait Implementations

impl Clone for StageHookScripts

fn clone(&self) -> StageHookScripts

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Component for StageHookScripts

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy_ecs::component::StorageType::Table

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 StageHookScripts

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

Formats the value using the given formatter.

impl Default for StageHookScripts

fn default() -> StageHookScripts

Returns the “default value” for a type.