|
35 | 35 | - [Structural Changes](#structural-changes) |
36 | 36 | - [Spawning Entities](#spawning-entities) |
37 | 37 | - [Entity Builders](#entity-builders) |
| 38 | + - [Multi-Entity Spawning](#multi-entity-spawning) |
38 | 39 | - [Access Operations](#access-operations) |
39 | 40 | - [Iterating Over Fragments](#iterating-over-fragments) |
40 | 41 | - [Modifying Operations](#modifying-operations) |
@@ -476,6 +477,54 @@ local enemy = evolved.builder() |
476 | 477 |
|
477 | 478 | Builders can be reused, so you can create a builder with a specific set of fragments and components and then use it to spawn multiple entities with the same fragments and components. |
478 | 479 |
|
| 480 | +#### Multi-Entity Spawning |
| 481 | + |
| 482 | +When you need to spawn multiple entities with identical fragments, use `multi_spawn` and `multi_clone` to optimize performance and reduce overhead. |
| 483 | + |
| 484 | +```lua |
| 485 | +---@param entity_count integer |
| 486 | +---@param component_table? evolved.component_table |
| 487 | +---@param component_mapper? evolved.component_mapper |
| 488 | +---@return evolved.entity[] entity_list |
| 489 | +---@return integer entity_count |
| 490 | +function evolved.multi_spawn(entity_count, component_table, component_mapper) end |
| 491 | + |
| 492 | +---@param entity_count integer |
| 493 | +---@param prefab evolved.entity |
| 494 | +---@param component_table? evolved.component_table |
| 495 | +---@param component_mapper? evolved.component_mapper |
| 496 | +---@return evolved.entity[] entity_list |
| 497 | +---@return integer entity_count |
| 498 | +function evolved.multi_clone(entity_count, prefab, component_table, component_mapper) end |
| 499 | +``` |
| 500 | + |
| 501 | +These functions behave like their single-entity counterparts, but they allow you to spawn or clone multiple entities in one call. This approach minimizes the overhead of repeated function calls and structural changes, improving performance when handling large numbers of entities. |
| 502 | + |
| 503 | +Typically, when spawning multiple entities, they share the same set of fragments, but their components can differ. You can achieve this by providing a `component_mapper` function, which receives the chunk and the range of places for the newly spawned entities. This avoids many `evolved.set` calls after spawning, which can be costly when creating many entities. |
| 504 | + |
| 505 | +Here is a small example of using `evolved.multi_spawn` with a `component_mapper`: |
| 506 | + |
| 507 | +```lua |
| 508 | +local evolved = require 'evolved' |
| 509 | + |
| 510 | +local position_x, position_y = evolved.id(2) |
| 511 | + |
| 512 | +evolved.multi_spawn(1000, { |
| 513 | + [position_x] = 0, |
| 514 | + [position_y] = 0, |
| 515 | +}, function(chunk, b_place, e_place) |
| 516 | + local x_components = chunk:components(position_x) |
| 517 | + local y_components = chunk:components(position_y) |
| 518 | + |
| 519 | + for i = b_place, e_place do |
| 520 | + x_components[i] = math.random(-100, 100) |
| 521 | + y_components[i] = math.random(-100, 100) |
| 522 | + end |
| 523 | +end) |
| 524 | +``` |
| 525 | + |
| 526 | +Of course, you can use `evolved.multi_clone` in the same way. Builders can also be used for multi-entity spawning and cloning by calling the corresponding methods on the builder object. |
| 527 | + |
479 | 528 | ### Access Operations |
480 | 529 |
|
481 | 530 | The library provides all the necessary functions to access entities and their components. I'm not going to cover all the accessor functions here, because they are pretty straightforward and self-explanatory. You can check the [API Reference](#api-reference) for all of them. Here are some of the most important ones: |
@@ -1519,6 +1568,7 @@ builder_mt:destruction_policy :: id -> builder |
1519 | 1568 | ### vX.Y.Z |
1520 | 1569 |
|
1521 | 1570 | - Added the new [`evolved.REALLOC`](#evolvedrealloc) and [`evolved.COMPMOVE`](#evolvedcompmove) fragment traits that allow customizing component storages |
| 1571 | +- Added `component_mapper` argument to the spawning and cloning functions that allows filling components in chunks during the operation |
1522 | 1572 |
|
1523 | 1573 | ### v1.7.0 |
1524 | 1574 |
|
|
0 commit comments