query

Documentation

Index

• type Query
  • func NewQuery(filter filter.LayoutFilter) *Query
  • func (q *Query) Count(w donburi.World) int
  • func (q *Query) EachEntity(w donburi.World, callback func(*donburi.Entry))
  • func (q *Query) FirstEntity(w donburi.World) (entry *donburi.Entry, ok bool)

Types

type Query

type Query struct {
	// contains filtered or unexported fields
}

Query represents a query for entities. It is used to filter entities based on their components. It receives arbitrary filters that are used to filter entities. It contains a cache that is used to avoid re-evaluating the query. So it is not recommended to create a new query every time you want to filter entities with the same query.

func NewQuery

func NewQuery(filter filter.LayoutFilter) *Query

NewQuery creates a new query. It receives arbitrary filters that are used to filter entities.

func (*Query) Count

func (q *Query) Count(w donburi.World) int

Count returns the number of entities that match the query.

func (*Query) EachEntity

func (q *Query) EachEntity(w donburi.World, callback func(*donburi.Entry))

EachEntity iterates over all entities that match the query.

func (*Query) FirstEntity

func (q *Query) FirstEntity(w donburi.World) (entry *donburi.Entry, ok bool)

FirstEntity returns the first entity that matches the query.