entity

Documentation

Index

• Variables
• type Entity
  • func NewEntity(id EntityId) Entity
  • func (e Entity) Id() EntityId
  • func (e Entity) IncVersion() Entity
  • func (e Entity) String() string
  • func (e Entity) Version() uint32
• type EntityId

Variables

var Null = Entity(0)

Null represents a invalid entity.

Types

type Entity

type Entity uint64

Entity is identifier of an entity. The first 32 bits are the entity id. The last 32 bits are the version. The version is incremented when the entity is destroyed.

func NewEntity

func NewEntity(id EntityId) Entity

NewEntity creates a new entity. The id is a unique identifier for the entity. To reuse the id, the id should be passed from the world that created the entity.

func (Entity) Id

func (e Entity) Id() EntityId

Id returns the entity id.

func (Entity) IncVersion

func (e Entity) IncVersion() Entity

IncVersion increments the entity version.

func (Entity) String

func (e Entity) String() string

func (Entity) Version

func (e Entity) Version() uint32

Version returns the entity version.

type EntityId

type EntityId uint32

EntityId is a unique identifier for an entity.