com.github.michaelbull.rs.bestiary

Class Beast

java.lang.Object

com.github.michaelbull.rs.bestiary.Beast

public final class Beast
extends java.lang.Object

Represents a beast in the RuneScape Bestiary.

See Also:

Beast Data

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Beast.Builder

Method Summary

Modifier and Type	Method and Description
static Beast.Builder	builder(int id)
boolean	equals(java.lang.Object o)
java.util.OptionalInt	getAnimation(java.lang.String name) Gets an Optional containing an animation's id by its name.
ImmutableMap<java.lang.String,java.lang.Integer>	getAnimations() Gets an ImmutableMap of animation names to animation ids.
ImmutableList<java.lang.String>	getAreas() Gets an ImmutableList of areas in which this beast is found.
int	getAttackLevel() Gets the beast's Attack level.
int	getCombatLevel() Gets the beast's combat level.
int	getDefenceLevel() Gets the beast's Defence level.
java.lang.String	getDescription() Gets the beast's description.
double	getExperience() Gets the amount of experience earned when killing this beast.
int	getId() Gets the beast's id.
int	getLifePoints() Gets the amount of life points the beast has.
int	getMagicLevel() Gets the beast's Magic level.
java.lang.String	getName() Gets the beast's name.
int	getRangedLevel() Gets the beast's Ranged level.
int	getRequiredSlayerLevel() Gets the Slayer level required to attackLevel this beast.
int	getSize() Gets the amount of tiles this beast occupies in the x and y dimension.
java.util.Optional<java.lang.String>	getSlayerCategory() Gets an Optional containing the Slayer category this beast belongs to.
java.util.Optional<java.lang.String>	getWeakness() Gets the beast's weakness.
int	hashCode()
boolean	isAggressive() Checks if the beast is aggressive.
boolean	isAttackable() Checks if the beast is attackable.
boolean	isMembersOnly() Checks if this beast is only accessible on members' worlds.
boolean	isPoisonous() Checks if this beast is poisonous.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

builder

public static Beast.Builder builder(int id)

getName

public java.lang.String getName()

Gets the beast's name.

Returns:

The beast's name,

getId

public int getId()

Gets the beast's id.

Returns:

The beast's id.

getDescription

public java.lang.String getDescription()

Gets the beast's description.

Returns:

The beast's description.

getWeakness

public java.util.Optional<java.lang.String> getWeakness()

Gets the beast's weakness.

Returns:

The beast's weakness.

isAttackable

public boolean isAttackable()

Checks if the beast is attackable.

Returns:

true if so, false otherwise.

isAggressive

public boolean isAggressive()

Checks if the beast is aggressive.

Returns:

true if so, false otherwise.

isPoisonous

public boolean isPoisonous()

Checks if this beast is poisonous.

Returns:

true if so, false otherwise.

getExperience

public double getExperience()

Gets the amount of experience earned when killing this beast.

Returns:

The amount of experience earned when killing this beast.

getLifePoints

public int getLifePoints()

Gets the amount of life points the beast has.

Returns:

The amount of life points the beast has.

getCombatLevel

public int getCombatLevel()

Gets the beast's combat level.

Returns:

The beast's combat level.

getDefenceLevel

public int getDefenceLevel()

Gets the beast's Defence level.

Returns:

The beast's Defence level.

getAttackLevel

public int getAttackLevel()

Gets the beast's Attack level.

Returns:

The beast's Attack level.

getMagicLevel

public int getMagicLevel()

Gets the beast's Magic level.

Returns:

The beast's Magic level.

getRangedLevel

public int getRangedLevel()

Gets the beast's Ranged level.

Returns:

The beast's Ranged level.

getRequiredSlayerLevel

public int getRequiredSlayerLevel()

Gets the Slayer level required to attackLevel this beast.

Returns:

The Slayer level required to attackLevel this beast.

getSize

public int getSize()

Gets the amount of tiles this beast occupies in the x and y dimension.

Returns:

The amount of tiles this beast occupies in the x and y dimension.

isMembersOnly

public boolean isMembersOnly()

Checks if this beast is only accessible on members' worlds.

Returns:

true if so, false otherwise.

getSlayerCategory

public java.util.Optional<java.lang.String> getSlayerCategory()

Gets an Optional containing the Slayer category this beast belongs to.

Returns:

An Optional containing the Slayer category this beast belongs to, or Optional.empty() if it does not belong to a Slayer category.

getAreas

public ImmutableList<java.lang.String> getAreas()

Gets an ImmutableList of areas in which this beast is found.

Returns:

An ImmutableList of areas in which this beast is found.

getAnimations

public ImmutableMap<java.lang.String,java.lang.Integer> getAnimations()

Gets an ImmutableMap of animation names to animation ids.

Returns:

An ImmutableMap of animation names to animation ids.

getAnimation

public java.util.OptionalInt getAnimation(java.lang.String name)

Gets an Optional containing an animation's id by its name.

Parameters:

name - The name of the animation.

Returns:

An OptionalInt containing an animation's id, or OptionalInt.empty() if no animation of that name was found.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object