store

Documentation

Index

• type EntityMapKey
  • func NewEntityMapKey(ent entity.Entity) EntityMapKey
• type Handler
• type Store
  • func NewStore(handler Handler) *Store
  • func (s *Store) AddEntityObj(ent entity.Entity)
  • func (s *Store) RemoveEntityObj(ent entity.Entity) bool

Types

type EntityMapKey

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

EntityMapKey is the tuple key for the entities map

func NewEntityMapKey

func NewEntityMapKey(ent entity.Entity) EntityMapKey

NewEntityMapKey constructs a new EntityMapKey from an Entity

type Handler

type Handler interface {
	// HandleEntityAdded handles a new entity being added to the store.
	HandleEntityAdded(ent entity.Entity)
	// HandleEntityRemoved handles a entity being removed from the store.
	HandleEntityRemoved(ent entity.Entity)
}

Handler handles store events.

type Store

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

Store tracks, refcounts, and de-duplicates known entities.

func NewStore

func NewStore(handler Handler) *Store

NewStore constructs a new Store.

func (*Store) AddEntityObj

func (s *Store) AddEntityObj(ent entity.Entity)

AddEntityObj adds an entity object to the store.

func (*Store) RemoveEntityObj

func (s *Store) RemoveEntityObj(ent entity.Entity) bool

RemoveEntityObj removes an entity object from the store. Returns if found.