five-on-it / apps/client/src/gui/game-ui / GameUi
Interface: GameUi
Defined in: apps/client/src/gui/game-ui.ts:102
The in-game UI.
Methods
carTag()
carTag(
kind,anchor):void
Defined in: apps/client/src/gui/game-ui.ts:106
The tag over a car (anchor gives the point over its roof every frame), or none.
Parameters
kind
CarTagKind | undefined
anchor
() => WorldPoint | undefined
Returns
void
claims()
claims(
event):boolean
Defined in: apps/client/src/gui/game-ui.ts:139
Whether a key press went to a field of the UI rather than to the game.
Parameters
event
KeyboardEvent
Returns
boolean
covers()
covers(
x,y):boolean
Defined in: apps/client/src/gui/game-ui.ts:137
Whether a point of the canvas (CSS px) is on a panel that takes the mouse.
Parameters
x
number
y
number
Returns
boolean
debug()
debug():
GuiDebug
Defined in: apps/client/src/gui/game-ui.ts:143
What the tests read.
Returns
dispose()
dispose():
void
Defined in: apps/client/src/gui/game-ui.ts:145
Removes it from the scene.
Returns
void
garage()
garage(
view):void
Defined in: apps/client/src/gui/game-ui.ts:121
A garage's panel at the wheel of a car standing in its bay, or none.
Parameters
view
GarageView | undefined
Returns
void
items()
items(
inventory,container,cash):void
Defined in: apps/client/src/gui/game-ui.ts:115
The inventory strip and the open container's or shop's panel.
Parameters
inventory
InventoryView | undefined
container
ContainerView | undefined
cash
number
Returns
void
mission()
mission(
mission,notices,cash,bank?):void
Defined in: apps/client/src/gui/game-ui.ts:108
The mission panel and a race's readout.
Parameters
mission
{ chase?: { distance: number; }; checkpoint?: boolean; completed: number; escort?: { following: boolean; health: number; }; group?: { done: number; need: number; }; hand?: object[]; helpline?: string; hold?: { distance?: number; left: number; total: number; }; members?: object[]; mission?: string; objective?: { count: number; id: string; index: number; text: string; verb: string; }; party?: object[]; photo?: { x: number; z: number; }; race?: { gate: number; gates: number; lap: number; laps: number; position: number; racers: number; startsIn?: number; }; reason?: string; status: "none" | "active" | "complete" | "failed"; target?: { radius: number; x: number; y?: number; z: number; }; targets?: object[]; timeLeft?: number; title?: string; total: number; type: "mission"; wallet: { cash: number; rep: number; }; winner?: string; } | undefined
notices
readonly ShownNotice[]
cash
number | undefined
bank?
number
Returns
void
phone()
phone(
phone,ui,me,radio?,jobs?):void
Defined in: apps/client/src/gui/game-ui.ts:127
The phone as the server says it and the player holds it; where the player is, for its map; the radio, for its Radio page (and what plays, said on it); the Jobs app's view, in the city.
Parameters
phone
{ apps: object[]; calls: object[]; camera?: { note?: "missed" | "subject" | "away" | "saved"; shots: number; }; contacts: object[]; has: boolean; messages: object[]; screen?: { app: string; buttons: object[]; form: object[]; kind: "keypad" | "app"; name: string; note?: string; noteKey?: "wrongCode" | "nothing"; source: "phone" | "world"; text: string; title?: string; }; talk?: { choices: object[]; dialogue: string; goesOn: boolean; line?: string; note?: string; speaker?: string; state: "ringing" | "talking"; via: "call" | "face"; with: string; }; type: "phone"; unread: number; waypoint?: { label?: string; x: number; z: number; }; } | undefined
ui
me
{ x: number; z: number; } | undefined
radio?
PhoneRadio & object
jobs?
Returns
void
prompt()
prompt(
prompt,anchor):void
Defined in: apps/client/src/gui/game-ui.ts:104
The prompt over the character (anchor gives its feet every frame), or none.
Parameters
prompt
PromptState | undefined
anchor
() => WorldPoint | undefined
Returns
void
radioWheel()
radioWheel(
view):void
Defined in: apps/client/src/gui/game-ui.ts:135
The radio wheel while its key is held, or none.
Parameters
view
WheelView | undefined
Returns
void
restyle()
restyle():
void
Defined in: apps/client/src/gui/game-ui.ts:141
Lays everything out again (the minimap's size changed).
Returns
void