docs: Add some documentation for the multiFactory in the SpawnComponent #3443
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
spydon
approved these changes
Jan 10, 2025
doc/flame/components.md
Outdated
Comment on lines
827
to
834
| The factory functions takes an `int` as an argument, which is the number of components that have | ||
| been spawned, so if for example 4 components have been spawned already the 5th call of the factory method will be called with the `amount=4`, since the counting starts at 0 for the first call. | ||
|
|
||
| The `factory` with a single component is for backward compatibility, so you should use the `multiFactory` if in doubt. A single component `factory` will be wrapped internally to return a single item list and then used as the `multiFactory`. | ||
|
|
There was a problem hiding this comment.
weird, I thought I had added newlines everywhere
There was a problem hiding this comment.
Should be better now.
pcornelissen
force-pushed
the
spawncomponent-multifactory-docs
branch
from
5d9b8d4 to
66dba81
Compare
pcornelissen
force-pushed
the
spawncomponent-multifactory-docs
branch
from
66dba81 to
6eaa176
Compare
pcornelissen
changed the title
spydon
approved these changes
Jan 10, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
The PR add some explanation for the new multiFactory feature in the SpawnComponent
Checklist
docsand added dartdoc comments with///.examplesordocs.Breaking Change?
Related Issues