Struct CommandScopeRegistry 

pub struct CommandScopeRegistry { /* private fields */ }

Store the scope graph and provide methods for querying it.

Implementations

impl CommandScopeRegistry

pub fn new() -> Self

Create a new scope registry.

pub fn add_scope<S: Into<String>>(&mut self, scope: S)

Add a scope to the registry.

Example

use chunkedge_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

// creates two nodes. "chunkedge" and "command" with an edge from "chunkedge" to "command"
registry.add_scope("chunkedge.command");
// creates one node. "chunkedge.command.tp" with an edge from "chunkedge.command" to
// "chunkedge.command.tp"
registry.add_scope("chunkedge.command.tp");

// the root node is always present
assert_eq!(registry.scope_count(), 4);

pub fn remove_scope(&mut self, scope: &str)

Remove a scope from the registry.

Example

use chunkedge_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("chunkedge.command");
registry.add_scope("chunkedge.command.tp");

assert_eq!(registry.scope_count(), 4);

registry.remove_scope("chunkedge.command.tp");

assert_eq!(registry.scope_count(), 3);

pub fn grants(&self, scope: &str, other: &str) -> bool

Check if a scope grants another scope.

Example

use chunkedge_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("chunkedge.command");
registry.add_scope("chunkedge.command.tp");

assert!(registry.grants("chunkedge.command", "chunkedge.command.tp")); // command implies tp
assert!(!registry.grants("chunkedge.command.tp", "chunkedge.command")); // tp does not imply command

pub fn any_grants(&self, scopes: &Vec<&str>, other: &str) -> bool

do any of the scopes in the list grant the other scope?

Example

use chunkedge_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("chunkedge.command");
registry.add_scope("chunkedge.command.tp");
registry.add_scope("chunkedge.admin");

assert!(registry.any_grants(
    &vec!["chunkedge.admin", "chunkedge.command"],
    "chunkedge.command.tp"
));

pub fn link(&mut self, scope: &str, other: &str)

Create a link between two scopes so that one implies the other. It will add them if they don’t exist.

Example

use chunkedge_command::CommandScopeRegistry;

let mut registry = CommandScopeRegistry::new();

registry.add_scope("chunkedge.command.tp");

registry.link("chunkedge.admin", "chunkedge.command");

assert!(registry.grants("chunkedge.admin", "chunkedge.command"));
assert!(registry.grants("chunkedge.admin", "chunkedge.command.tp"));

pub fn scope_count(&self) -> usize

Get the number of scopes in the registry.

Trait Implementations

impl Clone for CommandScopeRegistry

fn clone(&self) -> CommandScopeRegistry

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Component for CommandScopeRegistry

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 CommandScopeRegistry

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

Formats the value using the given formatter.

impl Default for CommandScopeRegistry

fn default() -> Self

Returns the “default value” for a type.

impl Resource for CommandScopeRegistry

where Self: Send + Sync + 'static,