Group

Struct Group 

Source
pub struct Group { /* private fields */ }
Expand description

A struct representing a group of entities in the ECS game systems.

Implementations§

Source§

impl Group

Source

pub fn get_count(&self) -> i32

Gets the number of entities in the group.

Source

pub fn get_first(&self) -> Option<Entity>

Gets the first entity in the group.

Source

pub fn find(&self, predicate: Box<dyn FnMut(&Entity) -> bool>) -> Option<Entity>

Finds the first entity in the group that satisfies a predicate function.

§Arguments
  • predicate - The predicate function to test each entity with.
§Returns
  • Option<Entity> - The first entity that satisfies the predicate, or None if no entity does.
Source

pub fn new(components: &Vec<&str>) -> Group

A method that creates a new group with the specified component names.

§Arguments
  • components - A vector listing the names of the components to include in the group.
§Returns
  • Group - The new group.
Source§

impl Group

Source

pub fn watch( &mut self, callback: Box<dyn FnMut(&mut CallStack) -> bool>, ) -> &mut Group

Watches the group for changes to its entities, calling a function whenever an entity is added or changed.

§Arguments
  • callback - The function to call when an entity is added or changed. Returns true to stop watching.
§Returns
  • Group - The same group, for method chaining.
Source

pub fn each(&self, visitor: Box<dyn FnMut(&Entity) -> bool>) -> bool

Calls a function for each entity in the group.

§Arguments
  • visitor - The function to call for each entity. Returning true inside the function will stop iteration.
§Returns
  • bool - Returns false if all entities were processed, true if the iteration was interrupted.

Trait Implementations§

Source§

impl Clone for Group

Source§

fn clone(&self) -> Group

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Drop for Group

Source§

fn drop(&mut self)

Executes the destructor for this type. Read more
Source§

impl IObject for Group

Source§

fn raw(&self) -> i64

Source§

fn obj(&self) -> &dyn IObject

Source§

fn as_any(&self) -> &dyn Any

Source§

fn get_id(&self) -> i32

Auto Trait Implementations§

§

impl Freeze for Group

§

impl RefUnwindSafe for Group

§

impl Send for Group

§

impl Sync for Group

§

impl Unpin for Group

§

impl UnwindSafe for Group

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.