4866344964

Committed 02 May 2023 10:26PM CUT coverage: 100.0%. Remained the same

Build Type

push

github

Committed by GitHub

Commit Message

Better document RelationsUnchecked et al. methods (#261)

Run Details

1 of 1 new or added line in 1 file covered. (100.0%)

3543 of 3543 relevant lines covered (100.0%)

1860.39 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

100.0

/ecs/entity.go

package ecs

import "reflect"

// Reflection type of an [Entity].
var entityType = reflect.TypeOf(Entity{})

// Size of an [Entity] in memory, in bytes.
var entitySize = entityType.Size()

// Size of an [entityIndex] in memory.
var entityIndexSize = reflect.TypeOf(entityIndex{}).Size()

// Entity identifier.
// Holds an entity ID and it's generation for recycling.
//
// Entities are only created via the [World], using [World.NewEntity] or [World.NewEntityWith].
// Batch creation of entities is possible via [Builder].
//
// Entities are intended to be stored and passed around via copy, not via pointers.
type Entity struct {
        id  eid    // Entity ID
        gen uint16 // Entity generation
}

// newEntity creates a new Entity.
func newEntity(id eid) Entity {
        return Entity{id, 0}
}

// newEntityGen creates a new Entity with a given generation.
func newEntityGen(id eid, gen uint16) Entity {
        return Entity{id, gen}
}

// IsZero returns whether this entity is the reserved zero entity.
func (e Entity) IsZero() bool {
        return e.id == 0
}

// entityIndex indicates where an entity is currently stored.
type entityIndex struct {
        arch     *archetype // Entity's current archetype
        index    uintptr    // Entity's current index in the archetype
        isTarget bool
}

1	package ecs
2
3	import "reflect"
4
5	// Reflection type of an [Entity].
6	var entityType = reflect.TypeOf(Entity{})
7
8	// Size of an [Entity] in memory, in bytes.
9	var entitySize = entityType.Size()
10
11	// Size of an [entityIndex] in memory.
12	var entityIndexSize = reflect.TypeOf(entityIndex{}).Size()
13
14	// Entity identifier.
15	// Holds an entity ID and it's generation for recycling.
16	//
17	// Entities are only created via the [World], using [World.NewEntity] or [World.NewEntityWith].
18	// Batch creation of entities is possible via [Builder].
19	//
20	// Entities are intended to be stored and passed around via copy, not via pointers.
21	type Entity struct {
22	id eid // Entity ID
23	gen uint16 // Entity generation
24	}
25
26	// newEntity creates a new Entity.
27	func newEntity(id eid) Entity {	6,368✔
28	return Entity{id, 0}	6,368✔
29	}	6,368✔
30
31	// newEntityGen creates a new Entity with a given generation.
32	func newEntityGen(id eid, gen uint16) Entity {	16✔
33	return Entity{id, gen}	16✔
34	}	16✔
35
36	// IsZero returns whether this entity is the reserved zero entity.
37	func (e Entity) IsZero() bool {	5,151✔
38	return e.id == 0	5,151✔
39	}	5,151✔
40
41	// entityIndex indicates where an entity is currently stored.
42	type entityIndex struct {
43	arch *archetype // Entity's current archetype
44	index uintptr // Entity's current index in the archetype
45	isTarget bool
46	}

mlange-42 / arche / 4866344964

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous