five-on-it / apps/server/src/bounties / BountyBoard
Class: BountyBoard
Defined in: apps/server/src/bounties.ts:50
The room's bounty board: who switched it on.
Constructors
Constructor
new BountyBoard():
BountyBoard
Returns
BountyBoard
Methods
claim()
claim(
carrier,by):BountyClaim|undefined
Defined in: apps/server/src/bounties.ts:97
Whether a player who downed or cuffed a carrier claims their bounty: both with the board on, the carrier at the stars for one and out of a safe zone, the claimer someone else.
Parameters
carrier
by
number
Returns
BountyClaim | undefined
drop()
drop(
client):void
Defined in: apps/server/src/bounties.ts:65
A player left: their board goes with them.
Parameters
client
number
Returns
void
isOn()
isOn(
client):boolean
Defined in: apps/server/src/bounties.ts:60
Whether a player's board is on.
Parameters
client
number
Returns
boolean
set()
set(
client,on):void
Defined in: apps/server/src/bounties.ts:54
Switches a player's board on or off.
Parameters
client
number
on
boolean
Returns
void
view()
view(
viewer,players):object
Defined in: apps/server/src/bounties.ts:70
The room's bounties as a player sees them: every carrier but themselves, where they are when near.
Parameters
viewer
client
number
x
number
z
number
players
readonly BountyPlayer[]
Returns
object
list
list:
object[]
on
on:
boolean