Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Particle Documentation is Outdated and Code Example No Longer Works in Version 4.0.3 #954

Open
Ultra4life opened this issue Oct 2, 2024 · 4 comments
Milestone

Comments

@Ultra4life
Copy link

Hello MonoGame.Extended team,

I have noticed that the documentation for the Particles component is outdated and no longer works in the latest version.
Specifically, code that used to function correctly in MonoGame.Extended.Particles version 3.8.0 is now broken with MonoGame.Extended version 4.0.3.

Here is an example of the code that worked in version 3.8.0:
var textureRegion = new TextureRegion2D(particleTexture);
var particleEffect = new ParticleEffect(autoTrigger: false);

However, with version 4.0.3 of MonoGame.Extended, this code throws errors and there seems to be no clear documentation or resources available online to indicate how to adjust this for the latest version.

Could the documentation for this part be updated, or could an example be provided for those of us looking to migrate or start new projects using the particle system in the latest version?

Thank you for your hard work, and I hope this issue can be resolved soon.

@Ultra4life
Copy link
Author

For thoses who are stuck like me :
I had to Downgrade MonoGameExtended to version 3.8.0
and re-install MonoGame.Extended.Particules 3.8.0, using the Dotnet commands, to finally make it work

dotnet add package MonoGame.Extended --version 3.8.0
dotnet add package MonoGame.Extended.Particles --version 3.8.0

@jeffgamedev
Copy link

Big things are coming to the particle system soon 👍

@AristurtleDev
Copy link
Collaborator

To give some feedback here, the particle system is being overhauled in a since. It looks like initially the port of Mercury Particle Engine that @dylanwilson80 did was also supported by an application he developed called Particle Factory. Particle Factory was a GUI application for designing the particles to use with the particle engine in MGE.

However it seems that there's no source available anywhere for Particle Factory so I've been developing a replacement which I've been testing at https://github.com/AristurtleDev/aristurtle-particle-engine-editor-private

A few things remain that need to be added to it to allow users like @jeffgamedev that used the original Particle Factory to import their saved files into the new system, once that's all completed, the code base will be brought over here and updated into the particle system.

@AristurtleDev
Copy link
Collaborator

Here is an example of the code that worked in version 3.8.0:
var textureRegion = new TextureRegion2D(particleTexture);
var particleEffect = new ParticleEffect(autoTrigger: false);

As for this issue, the emitters that are in the particle effect are the ones with the AutoTrigger property, not the effect itself. So you would need to set the auto trigger for them instead.

@AristurtleDev AristurtleDev added this to the v4.1.0 milestone Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants