DrunkGuy
extends Mission
in package
Read onlyYes
Table of Contents
Constants
- MISSIONS = [0 => \Smr\Missions\DrunkGuy::class]
- REWARD_CREDITS = 500000
- REWARD_EXP = 1000
Properties
- $barSectorID : int
- $drinkName : string
- $gameID : int
- $hqSectorID : int
- $raceName : string
- $startSectorID : int
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
- pickSector() : int
Constants
MISSIONS
public
mixed
MISSIONS
= [0 => \Smr\Missions\DrunkGuy::class]
REWARD_CREDITS
private
mixed
REWARD_CREDITS
= 500000
REWARD_EXP
private
mixed
REWARD_EXP
= 1000
Properties
$barSectorID
private
int
$barSectorID
$drinkName
private
string
$drinkName
$gameID
private
int
$gameID
$hqSectorID
private
int
$hqSectorID
$raceName
private
string
$raceName
$startSectorID
private
int
$startSectorID
Methods
__construct()
public
__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
getStep(int $step) : MissionStep
Parameters
- $step : int
Return values
MissionStepisAvailableToPlayer()
Is the player eligible to accept the mission in their current state?
public
static isAvailableToPlayer(AbstractPlayer $player) : bool
Parameters
- $player : AbstractPlayer
Return values
boolreward()
public
reward(AbstractPlayer $player) : string
Parameters
- $player : AbstractPlayer
Return values
stringpickSector()
private
pickSector(int|string $loc, int $fromSectorID[, array<string|int, int> $excludeSectorIDs = null ]) : int
Parameters
- $loc : int|string
- $fromSectorID : int
- $excludeSectorIDs : array<string|int, int> = null
-
Sectors to exclude from picking.