Mission
in package
Read onlyYes
AbstractYes
Table of Contents
Constants
- MISSIONS = [0 => \Smr\Missions\DrunkGuy::class]
Methods
- __construct() : mixed
- claimReward() : string
- Bestows the reward to the player upon completion.
- getFirstMessage() : string
- Get the prompt to display if the Mission is available to the player.
- getMissionID() : int
- Look up the mission ID for this Mission instance based on the class.
- getStep() : MissionStep
- Get the details of the current Mission step.
- isAvailableToPlayer() : bool
- Is the player eligible to accept the mission in their current state?
- reward() : string
Constants
MISSIONS
public
mixed
MISSIONS
= [0 => \Smr\Missions\DrunkGuy::class]
Methods
__construct()
public
abstract __construct(AbstractPlayer $player) : mixed
Parameters
- $player : AbstractPlayer
claimReward()
Bestows the reward to the player upon completion.
public
claimReward(AbstractPlayer $player) : string
Parameters
- $player : AbstractPlayer
Return values
stringgetFirstMessage()
Get the prompt to display if the Mission is available to the player.
public
getFirstMessage() : string
Return values
stringgetMissionID()
Look up the mission ID for this Mission instance based on the class.
public
getMissionID() : int
Return values
intgetStep()
Get the details of the current Mission step.
public
abstract getStep(int $step) : MissionStep
Parameters
- $step : int
Return values
MissionStepisAvailableToPlayer()
Is the player eligible to accept the mission in their current state?
public
abstract static isAvailableToPlayer(AbstractPlayer $player) : bool
Parameters
- $player : AbstractPlayer
Return values
boolreward()
protected
abstract reward(AbstractPlayer $player) : string
Parameters
- $player : AbstractPlayer