Documentation

Bounty
in package

Table of Contents

Constants

MAX_CREDITS  = SQL_MAX_UNSIGNED_INT
Maximum amount of bounty.credits in the database

Properties

$bountyID  : int
$gameID  : int
$targetID  : int
$time  : int
$type  : BountyType
$claimerID  : int
$credits  : int
$hasChanged  : bool
$smrCredits  : int

Methods

__construct()  : mixed
getClaimableByPlayer()  : array<string|int, self>
Get bounties that can be claimed by this player.
getClaimerPlayer()  : AbstractPlayer
getCredits()  : int
getFromRecord()  : self
getMostWanted()  : array<string|int, self>
Returns a list of all active (not claimable) bounties for given location $type.
getPlacedOnPlayer()  : array<int, self>
Get bounties that have been placed on this player.
getSmrCredits()  : int
getTargetPlayer()  : AbstractPlayer
increaseCredits()  : void
increaseSmrCredits()  : void
isActive()  : bool
setClaimable()  : void
setClaimed()  : void
update()  : bool
setCredits()  : void
setSmrCredits()  : void

Constants

MAX_CREDITS

Maximum amount of bounty.credits in the database

private mixed MAX_CREDITS = SQL_MAX_UNSIGNED_INT

Properties

$bountyID read-only

public int $bountyID

$gameID read-only

public int $gameID

$targetID read-only

public int $targetID

$time read-only

public int $time

$claimerID

private int $claimerID = 0

$credits

private int $credits = 0

$hasChanged

private bool $hasChanged = true

$smrCredits

private int $smrCredits = 0

Methods

__construct()

public __construct(int $targetID, int $bountyID, int $gameID, BountyType $type, int $time[, int $claimerID = 0 ][, int $credits = 0 ][, int $smrCredits = 0 ][, bool $hasChanged = true ]) : mixed
Parameters
$targetID : int
$bountyID : int
$gameID : int
$type : BountyType
$time : int
$claimerID : int = 0
$credits : int = 0
$smrCredits : int = 0
$hasChanged : bool = true

getClaimableByPlayer()

Get bounties that can be claimed by this player.

public static getClaimableByPlayer(AbstractPlayer $player[, BountyType|null $type = null ]) : array<string|int, self>
Parameters
$player : AbstractPlayer
$type : BountyType|null = null
Return values
array<string|int, self>

getCredits()

public getCredits() : int
Return values
int

getMostWanted()

Returns a list of all active (not claimable) bounties for given location $type.

public static getMostWanted(BountyType $type, int $gameID) : array<string|int, self>
Parameters
$type : BountyType
$gameID : int
Return values
array<string|int, self>

getPlacedOnPlayer()

Get bounties that have been placed on this player.

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

getSmrCredits()

public getSmrCredits() : int
Return values
int

increaseCredits()

public increaseCredits(int $credits) : void
Parameters
$credits : int

increaseSmrCredits()

public increaseSmrCredits(int $smrCredits) : void
Parameters
$smrCredits : int

isActive()

public isActive() : bool
Return values
bool

setClaimable()

public setClaimable(int $claimerID) : void
Parameters
$claimerID : int

setClaimed()

public setClaimed() : void

update()

public update() : bool
Return values
bool —

Whether or not the database was updated

setCredits()

private setCredits(int $credits) : void
Parameters
$credits : int

setSmrCredits()

private setSmrCredits(int $smrCredits) : void
Parameters
$smrCredits : int 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results