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
Update Effects page #638
Update Effects page #638
Conversation
A preview for this pull request is available at https://cdn.rawgit.com/Spongy/SpongeDocs-PRs/4dd619c/. Here are some links to the pages that were modified: Since the preview frequently changes, please link to this comment, not to the direct url to the preview. |
Ready for review |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
All I can find is shonky wording from a previous edition of the page. Well done.
source/plugin/effects.rst
Outdated
.type(ParticleTypes.LAVA).count(50).build(); | ||
.type(ParticleTypes.LAVA) | ||
.quantity(50) | ||
.build(); | ||
viewer.spawnParticles(effect, position); | ||
|
||
Using a :javadoc:`ParticleEffect.Builder`, we can specify the type of particle we | ||
would like to spawn. With this, we also specify that fifty particles will be in the particle effect. | ||
|
||
Now if we wanted to make a more specific particle, say the particle of a block, then we can use one of the serveral |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
serveral --> several
source/plugin/effects.rst
Outdated
classes found in the :javadoc:`org.spongepowered.api.effect.particle` package. For example, let's say we wanted to | ||
spawn the particle of a sand, :javadoc:`ParticleTypes#BLOCK_CRACK`. We would need to use the :javadoc:`BlockParticle` | ||
class and specify that we would like to use a sand block. This can be done like so: | ||
types found in the :javadoc:`ParticleTypes` class. For example, let's say we wanted to spawn the particle of a sand, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do you mean "spawn the particle of sand" or "spawn the particle of a sand block"? This might work better using the plural too, ie. "spawn particles of ...".
Like this? |
This PR seems to be gathering dust. You might want another reviewer, or we can just merge it. |
My original plan was to have two reviewers, but because this are only small changes we can merge it directly if you are fine with it. Once API 7 is merged in/soon I will do another check for outdated classes on the docs anyway. |
I might just merge this shortly anyway if @Meronat is unavailable to do a quick review. |
Adjusts the effects page to API 5 and later.
IMO multiline builder improve readability. Do you agree or shall I change it back?