Struct OperatorEntity 

pub struct OperatorEntity { /* private fields */ }

Child of an Extension; represents a single operator.

Holds the SystemIds that the dispatcher runs. An observer on On<Remove, OperatorEntity> unregisters those systems when this entity despawns, and keeps the OperatorIndex in sync.

Implementations

impl OperatorEntity

pub fn id(&self) -> &'static str

Stable string id (e.g. "physics.enable").

pub fn label(&self) -> &'static str

User-facing label for menus, buttons, and the keybind UI.

pub fn description(&self) -> &'static str

One-sentence description shown in tooltips and the (planned) command palette.

pub fn parameters(&self) -> &'static [ParamSpec]

Static parameter schema declared in the operator’s #[operator(params(...))] block. Empty for ops that take no parameters.

pub fn is_modal(&self) -> bool

True if this operator is declared modal = true. Modal ops can return OperatorResult::Running to enter a multi-frame session that the dispatcher manages via ActiveModalOperator.

pub fn allows_undo(&self) -> bool

True if a successful call should push an undo entry. Mirrors the operator’s allows_undo = ... flag. Operators with this set to false can still implement custom undo by pushing EditorCommands directly, but the snapshot dispatcher won’t auto-capture for them.

Trait Implementations

impl Clone for OperatorEntity

fn clone(&self) -> OperatorEntity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for OperatorEntity

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_replace() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_replace 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 OperatorEntity

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

Formats the value using the given formatter.