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/config.go

package ecs

// Config provides configuration for an ECS [World].
type Config struct {
        // Capacity increment for archetypes and the entity index.
        // The default value is 128.
        CapacityIncrement int
        // Capacity increment for archetypes with a relation component.
        // The default value is CapacityIncrement.
        RelationCapacityIncrement int
}

// NewConfig creates a new default [World] configuration.
func NewConfig() Config {
        return Config{
                CapacityIncrement:         128,
                RelationCapacityIncrement: 0,
        }
}

// WithCapacityIncrement return a new Config with CapacityIncrement set.
// Use with method chaining.
func (c Config) WithCapacityIncrement(inc int) Config {
        c.CapacityIncrement = inc
        return c
}

// WithRelationCapacityIncrement return a new Config with RelationCapacityIncrement set.
// Use with method chaining.
func (c Config) WithRelationCapacityIncrement(inc int) Config {
        c.RelationCapacityIncrement = inc
        return c
}

1	package ecs
2
3	// Config provides configuration for an ECS [World].
4	type Config struct {
5	// Capacity increment for archetypes and the entity index.
6	// The default value is 128.
7	CapacityIncrement int
8	// Capacity increment for archetypes with a relation component.
9	// The default value is CapacityIncrement.
10	RelationCapacityIncrement int
11	}
12
13	// NewConfig creates a new default [World] configuration.
14	func NewConfig() Config {	80✔
15	return Config{	80✔
16	CapacityIncrement: 128,	80✔
17	RelationCapacityIncrement: 0,	80✔
18	}	80✔
19	}	80✔
20
21	// WithCapacityIncrement return a new Config with CapacityIncrement set.
22	// Use with method chaining.
23	func (c Config) WithCapacityIncrement(inc int) Config {	7✔
24	c.CapacityIncrement = inc	7✔
25	return c	7✔
26	}	7✔
27
28	// WithRelationCapacityIncrement return a new Config with RelationCapacityIncrement set.
29	// Use with method chaining.
30	func (c Config) WithRelationCapacityIncrement(inc int) Config {	3✔
31	c.RelationCapacityIncrement = inc	3✔
32	return c	3✔
33	}	3✔

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