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

Update Effects page #638

Merged
merged 2 commits into from Feb 23, 2018
Merged

Update Effects page #638

merged 2 commits into from Feb 23, 2018

Conversation

ST-DDT
Copy link
Member

@ST-DDT ST-DDT commented Nov 27, 2017

Adjusts the effects page to API 5 and later.


IMO multiline builder improve readability. Do you agree or shall I change it back?

@Spongy
Copy link

Spongy commented Nov 27, 2017

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.

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 28, 2017

Ready for review

Copy link
Member

@Inscrutable Inscrutable left a 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.

.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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

serveral --> several

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,
Copy link
Member

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 ...".

@ST-DDT
Copy link
Member Author

ST-DDT commented Nov 30, 2017

Like this?

@ST-DDT ST-DDT added the needs review The submission is ready and needs to be reviewed label Dec 3, 2017
@Inscrutable
Copy link
Member

This PR seems to be gathering dust. You might want another reviewer, or we can just merge it.

@ST-DDT
Copy link
Member Author

ST-DDT commented Jan 7, 2018

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.

@Inscrutable Inscrutable added this to the v5.0.0 milestone Jan 8, 2018
@Inscrutable Inscrutable requested review from parlough and removed request for 12awsomeman34 January 8, 2018 11:09
@Inscrutable Inscrutable modified the milestones: v5.0.0, v5.1.0 Jan 8, 2018
@Inscrutable
Copy link
Member

I might just merge this shortly anyway if @Meronat is unavailable to do a quick review.
This could be cherry-picked back to the API 5 and 6 branches, if anyone is keen.

@ST-DDT ST-DDT mentioned this pull request Feb 18, 2018
@Inscrutable Inscrutable removed the request for review from parlough February 23, 2018 10:41
@Inscrutable Inscrutable merged commit 90c8a99 into stable Feb 23, 2018
@ST-DDT ST-DDT deleted the fixes/effects branch April 15, 2018 20:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs review The submission is ready and needs to be reviewed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants