Skip to content

Commit

Permalink
More explanations in documentation
Browse files Browse the repository at this point in the history
Made documentation explain delay and type.
  • Loading branch information
tlf30 committed Sep 4, 2018
1 parent f6bf374 commit 828cf12
Showing 1 changed file with 7 additions and 5 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -16,20 +16,22 @@ public final class SendPlaySoundMessage extends Message {

/**
* The delay that the client should use before playing the sound.
* Deplay is measured in milliseconds.
*/
private final int delay;

/**
* The type of sound to play.
* Usually 0.
*/
private final int type;

/**
* Creates a new send play sound message.
*
* @param id The id of the sound to play.
* @param type The type of the sound to play.
* @param delay The delay before the client plays the sound
* @param type The type of the sound to play, usually 0.
* @param delay The delay in milliseconds before the client plays the sound
*/
public SendPlaySoundMessage(int id, int type, int delay) {
this.id = id;
Expand All @@ -56,12 +58,12 @@ public int getType() {
}

/**
* Gets the delay of the sound.
* Gets the number of milliseconds for the client to delay before playing the sound.
*
* @return The delay of the sound.
* @return The delay of the sound in milliseconds.
*/
public int getDelay() {
return delay;
}

}
}

0 comments on commit 828cf12

Please sign in to comment.