Documentation

HallOfFame
in package

Collection of functions to help display the Hall of Fame tables.

Table of Contents

Methods

applyHofVisibilityMask()  : string|float
Conditionally hide displayed HoF stat.
buildBreadcrumb()  : string
displayHOFRow()  : string
getHofCategories()  : array<string|int, array<string, string>>
getHofRank()  : array{Rank: int, Amount: float|string}

Methods

applyHofVisibilityMask()

Conditionally hide displayed HoF stat.

public static applyHofVisibilityMask(float $amount, string $vis, int|null $gameID, int $accountID) : string|float

Hide the amount for:

  • alliance stats in live games for players not in your alliance
  • private stats for players who are not the current player
Parameters
$amount : float
$vis : string
$gameID : int|null
$accountID : int
Return values
string|float

buildBreadcrumb()

public static buildBreadcrumb(HallOfFameAll|HallOfFamePersonal $page, string $hofName) : string
Parameters
$page : HallOfFameAll|HallOfFamePersonal
$hofName : string
Return values
string

displayHOFRow()

public static displayHOFRow(int $rank, int $accountID, int|null $gameID, float|string $amount) : string
Parameters
$rank : int
$accountID : int
$gameID : int|null
$amount : float|string
Return values
string

getHofCategories()

public static getHofCategories(HallOfFameAll|HallOfFamePersonal $page, array<string|int, string> $allowedVis, int|null $game_id, int $account_id) : array<string|int, array<string, string>>
Parameters
$page : HallOfFameAll|HallOfFamePersonal
$allowedVis : array<string|int, string>
$game_id : int|null
$account_id : int
Return values
array<string|int, array<string, string>>

getHofRank()

public static getHofRank(string $viewType, int $accountID, int|null $gameID) : array{Rank: int, Amount: float|string}
Parameters
$viewType : string
$accountID : int
$gameID : int|null
Return values
array{Rank: int, Amount: float|string} 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results