nitro/Arcturus-Community
1
0
Fork 0
mirror of https://git.krews.org/morningstar/Arcturus-Community.git synced 2025-01-18 23:46:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Added full comments to PetCommand.java

Browse Source
This commit is contained in:
Harmonic 2023-01-06 19:24:27 -08:00
parent d4b3355068
commit 60bf49df74
1 changed files with 30 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

36
src/main/java/com/eu/habbo/habbohotel/pets/PetCommand.java
View File

@ -8,28 +8,38 @@ import com.eu.habbo.messages.outgoing.rooms.users.UserUpdateComposer;
import java.sql.ResultSet;
import java.sql.SQLException;
/**
* A class representing a command that can be given to a pet.
*/
public class PetCommand implements Comparable<PetCommand> {
/** The ID of the command. */
public final int id;
/** The key (name) of the command. */
public final String key;
/** The level required to use the command. */
public final int level;
/** The amount of XP rewarded for using the command. */
public final int xp;
/** The cost in energy to use the command. */
public final int energyCost;
/** The cost in happiness to use the command. */
public final int happynessCost;
/** The action associated with the command. */
public final PetAction action;
/**
* Creates a new PetCommand instance.
* @param set The ResultSet to get data from.
* @param action The PetAction associated with the command.
* @throws SQLException If a database error occurs.
*/
public PetCommand(ResultSet set, PetAction action) throws SQLException {
this.id = set.getInt("command_id");
this.key = set.getString("text");
@ -40,11 +50,24 @@ public class PetCommand implements Comparable<PetCommand> {
this.action = action;
}
/**
* Compares this PetCommand to another PetCommand based on the required level to use them.
* @param o The other PetCommand to compare to.
* @return A negative integer, zero, or a positive integer as this object is less than, equal to, or greater than the specified object.
*/
@Override
public int compareTo(PetCommand o) {
return this.level - o.level;
}
/**
* Handles the execution of the command for a given pet, Habbo, and data.
* If the pet does not have enough energy or happiness, or if a random check fails, the pet will "disobey" the command.
* Otherwise, the action associated with the command is applied and the pet's energy, happiness, and experience are updated.
* @param pet The pet to execute the command on.
* @param habbo The Habbo giving the command.
* @param data The data associated with the command.
*/
public void handle(Pet pet, Habbo habbo, String[] data) {
// check if enough energy, happiness, and randomize do or dont || should possibly add if not hungry and thirsty but @brenoepic does those - oliver
if (this.action != null && pet.energy > this.energyCost && pet.happyness > this.happynessCost && Emulator.getRandom().nextInt((pet.level - this.level <= 0 ? 2 : pet.level - this.level) + 2) == 0) {
@ -80,3 +103,4 @@ public class PetCommand implements Comparable<PetCommand> {
}
}
}