Class ShearSheepChallenge

java.lang.Object

com.storytimeproductions.models.stgames.challenges.ShearSheepChallenge

All Implemented Interfaces:

StoryBlitzChallenge, org.bukkit.event.Listener

public class ShearSheepChallenge
extends Object
implements StoryBlitzChallenge, org.bukkit.event.Listener

A challenge where players must shear a sheep. The number of sheep is the number of alive players minus one. All sheep, wool (in inventory and on the ground), and shears are removed on cleanup.

Constructor Summary

Constructors

Constructor	Description
ShearSheepChallenge(List<Cuboid> spawnRegions)	Constructs a ShearSheepChallenge using the provided spawn regions.

Method Summary

Modifier and Type	Method	Description
void	cleanup(List<org.bukkit.entity.Player> players)	Called when the challenge ends (cleanup).
String	getDescription()	Returns the description of the challenge, which is shown to players.
boolean	isCompleted(org.bukkit.entity.Player player)	Checks if the player has completed the challenge.
void	onPlayerShearSheep(org.bukkit.event.player.PlayerShearEntityEvent event)	Handles the event when a player shears a sheep.
void	start(List<org.bukkit.entity.Player> players)	Called when the challenge starts for the given players.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface StoryBlitzChallenge

getDescriptionWithGoob

Modifier and Type	Method	Description
default String	getDescriptionWithGoob(String normalDescription)	Returns a description with a chance to include "goob" for fun.

Constructor Details

ShearSheepChallenge

public ShearSheepChallenge(List<Cuboid> spawnRegions)

Constructs a ShearSheepChallenge using the provided spawn regions.

Parameters:

spawnRegions - List of Cuboid regions to spawn sheep in

Method Details

getDescription

public String getDescription()

Description copied from interface: StoryBlitzChallenge

Returns the description of the challenge, which is shown to players.

Specified by:

getDescription in interface StoryBlitzChallenge

Returns:

The description of the challenge.

start

public void start(List<org.bukkit.entity.Player> players)

Description copied from interface: StoryBlitzChallenge

Called when the challenge starts for the given players.

Specified by:

start in interface StoryBlitzChallenge

Parameters:

players - The players in the game.

isCompleted

public boolean isCompleted(org.bukkit.entity.Player player)

Description copied from interface: StoryBlitzChallenge

Checks if the player has completed the challenge.

Specified by:

isCompleted in interface StoryBlitzChallenge

Parameters:

player - The player to check.

Returns:

true if the player has completed the challenge, false otherwise.

cleanup

public void cleanup(List<org.bukkit.entity.Player> players)

Description copied from interface: StoryBlitzChallenge

Called when the challenge ends (cleanup).

Specified by:

cleanup in interface StoryBlitzChallenge

Parameters:

players - The players in the game.

onPlayerShearSheep

public void onPlayerShearSheep(org.bukkit.event.player.PlayerShearEntityEvent event)

Handles the event when a player shears a sheep.

Parameters:

event - The PlayerShearEntityEvent triggered when a player shears a sheep