Struct ark_api::world::WorldEntityQueryBuilder

pub struct WorldEntityQueryBuilder { /* private fields */ }

Use a WorldEntityQueryBuilder to build a WorldEntityQuery with an ergonomic interface.

Implementations

impl WorldEntityQueryBuilder

pub fn new(query_type: EntityQueryType) -> Self

Builds a new WorldEntityQueryBuilder from a EntityQueryType

pub fn with_layer_filter(&mut self, layer_filter: EntityLayerMask) -> &mut Self

Sets a layer filter on the query to be built.

Note that not calling this means to return everything regardless of layer. This cannot currently be expressed with an EntityLayerMask as everything will exclude entities that belong to no layer.

pub fn with_tag(&mut self, tag: u64) -> &mut Self

Add a tag to be included in the query

pub fn without_tag(&mut self, tag: u64) -> &mut Self

Exclude a tag from the query

pub fn build(&mut self) -> WorldEntityQuery

Build the WorldEntityQuery

Trait Implementations

impl Clone for WorldEntityQueryBuilder

fn clone(&self) -> WorldEntityQueryBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for WorldEntityQueryBuilder

fn default() -> Self

Returns the “default value” for a type.

impl Copy for WorldEntityQueryBuilder