Struct ScriptCallbackEvent

#[non_exhaustive]
pub struct ScriptCallbackEvent {
    pub label: CallbackLabel,
    pub recipients: Recipients,
    pub args: Vec<ScriptValue>,
    pub trigger_response: bool,
}

A callback event meant to trigger a callback in a subset/set of scripts in the world with the given arguments

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

label: CallbackLabel

The label of the callback

recipients: Recipients

The recipients of the callback

args: Vec<ScriptValue>

The arguments to the callback

trigger_response: bool

Whether the callback should emit a response event

Implementations

impl ScriptCallbackEvent

pub fn new<L>( label: L, args: Vec<ScriptValue>, recipients: Recipients, ) -> ScriptCallbackEvent

where L: Into<CallbackLabel>,

Creates a new callback event with the given label, arguments and recipients

pub fn with_response(self) -> ScriptCallbackEvent

Marks this event as expecting a response.

When set, an ScriptCallbackResponse event will be emitted when the callback is completed with the result of the callback IF the callback was executed.

pub fn new_for_all<L>(label: L, args: Vec<ScriptValue>) -> ScriptCallbackEvent

where L: Into<CallbackLabel>,

Creates a new callback event with the given label, arguments and all scripts as recipients

Trait Implementations

impl Clone for ScriptCallbackEvent

fn clone(&self) -> ScriptCallbackEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for ScriptCallbackEvent

where ScriptCallbackEvent: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

fn register_component_hooks(_hooks: &mut ComponentHooks)

Called when registering this component, allowing mutable access to its ComponentHooks.

fn register_required_components( _component_id: ComponentId, _components: &mut Components, _storages: &mut Storages, _required_components: &mut RequiredComponents, _inheritance_depth: u16, )

Registers required components.

impl Debug for ScriptCallbackEvent

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

Formats the value using the given formatter.

impl Event for ScriptCallbackEvent

where ScriptCallbackEvent: Send + Sync + 'static,

const AUTO_PROPAGATE: bool = false

When true, this event will always attempt to propagate when triggered, without requiring a call to Trigger::propagate.

type Traversal = ()

The component that describes which Entity to propagate this event to next, when propagation is enabled.