com.bgsoftware.superiorskyblock.api.handlers

Interface MissionsManager

public interface MissionsManager

Method Summary

Modifier and Type	Method and Description
boolean	canComplete(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not a player can complete a mission.
boolean	canCompleteAgain(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not the player can complete the mission again.
boolean	canCompleteNoProgress(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not a player can complete a mission, without considering progress.
boolean	canPassAllChecks(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not a player can pass all the checks to complete a mission.
java.util.List<Mission<?>>	getAllMissions() Get a list of all the missions.
java.util.List<Mission<?>>	getIslandMissions() Get a list of all missions that are island missions.
Mission<?>	getMission(java.lang.String name) Get a mission by its name.
java.util.List<MissionCategory>	getMissionCategories() Get all the mission categories.
MissionCategory	getMissionCategory(java.lang.String name) Get a mission category by its name.
java.util.List<Mission<?>>	getPlayerMissions() Get a list of all missions that are player missions.
boolean	hasAllRequiredMissions(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not a player has all the required missions to complete a mission.
boolean	hasCompleted(SuperiorPlayer superiorPlayer, Mission<?> mission) Check whether or not the player has already completed the mission.
void	loadMissionsData() Load all data related to missions.
void	loadMissionsData(java.util.List<Mission<?>> missionsList) Load all data related to missions of specific missions.
void	rewardMission(Mission<?> mission, SuperiorPlayer superiorPlayer, boolean checkAutoReward) Reward a player for completing a specific mission.
void	rewardMission(Mission<?> mission, SuperiorPlayer superiorPlayer, boolean checkAutoReward, boolean forceReward) Reward a player for completing a specific mission.
void	rewardMission(Mission<?> mission, SuperiorPlayer superiorPlayer, boolean checkAutoReward, boolean forceReward, java.util.function.Consumer<java.lang.Boolean> result) Reward a player for completing a specific mission.
void	saveMissionsData() Save all data related to missions.

Method Detail

getMission

@Nullable
Mission<?> getMission(java.lang.String name)

Get a mission by its name.

Parameters:

name - The name to check.

getAllMissions

java.util.List<Mission<?>> getAllMissions()

Get a list of all the missions.

getPlayerMissions

java.util.List<Mission<?>> getPlayerMissions()

Get a list of all missions that are player missions.

getIslandMissions

java.util.List<Mission<?>> getIslandMissions()

Get a list of all missions that are island missions.

getMissionCategory

@Nullable
MissionCategory getMissionCategory(java.lang.String name)

Get a mission category by its name.

Parameters:

name - The name to check.

getMissionCategories

java.util.List<MissionCategory> getMissionCategories()

Get all the mission categories.

hasCompleted

boolean hasCompleted(SuperiorPlayer superiorPlayer,
                     Mission<?> mission)

Check whether or not the player has already completed the mission.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player has completed, otherwise false.

canComplete

boolean canComplete(SuperiorPlayer superiorPlayer,
                    Mission<?> mission)

Check whether or not a player can complete a mission.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player can complete, otherwise false.

canCompleteNoProgress

boolean canCompleteNoProgress(SuperiorPlayer superiorPlayer,
                              Mission<?> mission)

Check whether or not a player can complete a mission, without considering progress.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player can complete, otherwise false.

canCompleteAgain

boolean canCompleteAgain(SuperiorPlayer superiorPlayer,
                         Mission<?> mission)

Check whether or not the player can complete the mission again.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player can complete, otherwise false.

hasAllRequiredMissions

boolean hasAllRequiredMissions(SuperiorPlayer superiorPlayer,
                               Mission<?> mission)

Check whether or not a player has all the required missions to complete a mission.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player has all required missions, otherwise false.

canPassAllChecks

boolean canPassAllChecks(SuperiorPlayer superiorPlayer,
                         Mission<?> mission)

Check whether or not a player can pass all the checks to complete a mission.

Parameters:

superiorPlayer - The player to check.

mission - The mission to check.

Returns:

True if player can pass all checks, otherwise false.

rewardMission

void rewardMission(Mission<?> mission,
                   SuperiorPlayer superiorPlayer,
                   boolean checkAutoReward)

Reward a player for completing a specific mission.

Parameters:

mission - The mission that was completed.

superiorPlayer - The player to reward.

checkAutoReward - Whether or not the auto reward flag should be checked.

rewardMission

void rewardMission(Mission<?> mission,
                   SuperiorPlayer superiorPlayer,
                   boolean checkAutoReward,
                   boolean forceReward)

Reward a player for completing a specific mission.

Parameters:

mission - The mission that was completed.

superiorPlayer - The player to reward.

checkAutoReward - Whether or not the auto reward flag should be checked.

forceReward - Should the plugin force the reward to the player (no checks will be ran)

rewardMission

void rewardMission(Mission<?> mission,
                   SuperiorPlayer superiorPlayer,
                   boolean checkAutoReward,
                   boolean forceReward,
                   @Nullable
                   java.util.function.Consumer<java.lang.Boolean> result)

Reward a player for completing a specific mission.

Parameters:

mission - The mission that was completed.

superiorPlayer - The player to reward.

checkAutoReward - Whether or not the auto reward flag should be checked.

forceReward - Should the plugin force the reward to the player (no checks will be ran)

result - The result of the reward.

saveMissionsData

void saveMissionsData()

Save all data related to missions. All the data is saved into a yaml file.

loadMissionsData

void loadMissionsData()

Load all data related to missions. All the data is loaded from a yaml file.

loadMissionsData

void loadMissionsData(java.util.List<Mission<?>> missionsList)

Load all data related to missions of specific missions. All the data is loaded from a yaml file.