Allow components ordering

[LeXXik]

Fixes #6647

The PR allows components to specify in which order they get enabled when multiple components are present on an Entity.

I confirm I have read the contributing guidelines and signed the Contributor License Agreement.

[LeXXik]

There is a potential (future?) conflict with a script component, which I noticed have the following line:

engine/src/framework/components/script/component.js

Lines 228 to 232 in 55a3ff8

	} else {
	// TODO scripts2
	// new script
	console.log(this.order);
	}

However, I am not sure what that is.

[mvaligursky]

I'm just wondering if this is too much. This allows sorting per component instance, with the order being stored for each instance of a component. I suspect that in reality, we need sorting based on the component type, and so we can avoid storing this per component instance, and store it as a static member of the component type.

Additionally, I think currently the array gets sorted each time a component is added. It's likely not a problem, as typically we only have a small number of components per entity. And each entity stores the sorted array as well, which is not ideal.

We could have a getter to get sorted components, and sort them at that point, as this is called at low frequency, and would avoid storing the array.

Thoughts? Just trying to make this as lightweight as possible.

[LeXXik]

Agreed, good points.

[LeXXik]

Having an order as a static is a better option. Thanks!

I tried to remove the sorted array store and move it to a getter, but not sure it is better than before. Now it gets sorted each time when onHierarchyStateChanged gets called. Instead of only once, when a component was added.

[LeXXik]

How about this variant?

[mvaligursky]

This feels right to me. I added some small comments.
I also would not mind few units tests to be added to test this if possible.

[Maksims]

Will it be more efficient to insert a component into its correct position at the moment of adding it, and avoid sorting altogether?

[mvaligursky]

Will it be more efficient to insert a component into its correct position at the moment of adding it, and avoid sorting altogether?

The component are not stored in an array, but an object. And we're trying to avoid storing additional array per entity.

[mvaligursky]

One last tiny rename suggestion, but otherwise awesome, thanks!