Documentation

MissionState
in package

Table of Contents

Properties

$accountID  : int
$gameID  : int
$mission  : Mission
$missionID  : int
$CACHE  : array<int, array<int, array<int, self>>>
$complete  : bool
$expires  : int
$hasChanged  : bool
$onStep  : int
$unread  : bool

Methods

addPlayerMission()  : self
Add a new mission for the given player.
checkAction()  : void
Check if an action satisfies the requirement for the current step, and if it does, advance to the next step.
clearCache()  : void
delete()  : void
getPlayerMissionStates()  : array<int, self>
Get existing missions for the given player.
getTask()  : string
getUnreadMessage()  : string|null
hasClaimableReward()  : bool
isComplete()  : bool
markComplete()  : void
markRead()  : void
saveMissionStates()  : void
__construct()  : mixed
advanceToNextStep()  : void
getFromRecord()  : self
getStep()  : MissionStep
isRequirementMet()  : bool
update()  : bool

Properties

$CACHE

private static array<int, array<int, array<int, self>>> $CACHE = []

Methods

checkAction()

Check if an action satisfies the requirement for the current step, and if it does, advance to the next step.

public checkAction(MissionAction $action) : void
Parameters
$action : MissionAction

getPlayerMissionStates()

Get existing missions for the given player.

public static getPlayerMissionStates(AbstractPlayer $player) : array<int, self>
Parameters
$player : AbstractPlayer
Return values
array<int, self>

getTask()

public getTask() : string
Return values
string

getUnreadMessage()

public getUnreadMessage() : string|null
Return values
string|null

hasClaimableReward()

public hasClaimableReward(int $sectorID) : bool
Parameters
$sectorID : int
Return values
bool

isComplete()

public isComplete() : bool
Return values
bool

saveMissionStates()

public static saveMissionStates() : void

__construct()

private __construct(int $accountID, int $gameID, int $missionID, Mission $mission, int $onStep, bool $unread, int $expires, bool $complete, bool $hasChanged) : mixed
Parameters
$accountID : int
$gameID : int
$missionID : int
$mission : Mission
$onStep : int
$unread : bool
$expires : int
$complete : bool
$hasChanged : bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results