feat: Added children parameter to Component constructor

[st-pasha]

Description

This PR allows to pass the list of children as a parameter directly into the Component's constructor. This is an alternative to standard add() or addAll() methods.

Checklist

• The title of my PR starts with a Conventional Commit prefix (fix:, feat:, docs: etc).
• I have read the Contributor Guide and followed the process outlined for submitting PRs.
• I have updated/added tests for ALL new/updated/fixed functionality.
• I have updated/added relevant documentation in docs and added dartdoc comments with ///.
• I have updated/added relevant examples in examples.

Breaking Change

• [-] Yes, this is a breaking change.
• No, this is not a breaking change.

Related Issues

Resolves #1522

[erickzanardo]

I think there a few components missing, SpriteAnimationComponent for example.

Also we probably should do the same on the bridge packages

[spydon]

Missing docs, and I thought maybe Erick wanted to implement this (and might have already started) since he opened the issue so always good to discuss on the issue who's going to implementing it before doing it.
Other than that it looks good!

[st-pasha]

I think there are a few components missing, SpriteAnimationComponent for example.

Right, so my thinking here is that we probably don't want to add children to those components which do not have children usually. For example, Effects are components, but it is not common to add other components to effect components.

Since I'm not exactly sure which components usually do or do not have children, I'll make a list and then you let me know which ones should get the parameter.

[spydon]

Since I'm not exactly sure which components usually do or do not have children, I'll make a list and then you let me know which ones should get the parameter.

I would say at least all Components deriving from PositionComponent.
BodyComponentin flame_forge2d should also have it, but #1506 should be merged first.
There are probably some more too?

[st-pasha]

• CircleHitbox
• CompositeHitbox
• PolygonHitbox
• RectangleHitbox
• ScreenHitbox
• ButtonComponent
• HudButtonComponent
• HudMarginComponent
• JoystickCompoenent
• SpriteButtonComponent
• CustomPainterComponent
• IsometricTileMapComponent
• NineTileBoxComponent
• ParallaxComponent
• ParticleSystemComponent
• SpriteAnimationComponent
• SpriteAnimationGroupComponent
• SpriteBatchComponent
• TextBoxComponent
• TextComponent
• TimerComponent
• CircleComponent
• PolygonComponent
• RectangleComponent
• ShapeComponent
• FlareActorComponent (flame_flare)
• BodyComponent (flame_forge2d)
• RiveComponent (flame_rive)
• SvgComponent (flame_svg)
• TiledComponent (flame_tiled)

[spydon]

The hitboxes and the TimerComponent doesn't need the field I'd say.

[erickzanardo]

Flame flare is kind obsolete because flame rive, so I would say that it can be omitted too

[spydon]

The CompositeHitbox would be nice to have the children field on btw, maybe with a tighter type than Component to indicate that hitboxes should be added to it.

[alestiago]

Looks good! I left some minor comments. But overall this is quite useful.

I wonder if it would be valuable to also ad tests for each subclass of Component to check if children is correctly set.

[alestiago]

Shall we also clarify, if the added children via children are accesible (or not) from an lifecycle method such as onLoad by reading children?

[st-pasha]

Added clarification.

[alestiago]

ensureAdd?

[st-pasha]

game.ready() does the same, without the need to use a special extension.

[erickzanardo]

You do write one line less though

[spydon]

After checking again I think that SpriteBatchComponent and ParticleSystemComponent shouldn't have this argument either.
After removing those I think we can merge this. :)

[st-pasha]

After checking again I think that SpriteBatchComponent and ParticleSystemComponent shouldn't have this argument either.
After removing those I think we can merge this. :)

Done.