steamworks.js-timmy 0.1.1 → 0.1.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/client.d.ts CHANGED
@@ -1,51 +1,62 @@
1
1
  export declare function init(appId?: number | undefined | null): void
2
- export declare function restartAppIfNecessary(appId: number): boolean
3
- export declare function runCallbacks(): void
2
+
4
3
  export interface PlayerSteamId {
5
4
  steamId64: bigint
6
5
  steamId32: string
7
6
  accountId: number
8
7
  }
8
+
9
+ export declare function restartAppIfNecessary(appId: number): boolean
10
+
11
+ export declare function runCallbacks(): void
12
+
9
13
  export declare namespace achievement {
10
14
  export function activate(achievement: string): boolean
11
- export function isActivated(achievement: string): boolean
12
15
  export function clear(achievement: string): boolean
16
+ export function isActivated(achievement: string): boolean
13
17
  export function names(): Array<string>
14
18
  }
19
+
15
20
  export declare namespace apps {
16
- export function isSubscribedApp(appId: number): boolean
17
- export function isAppInstalled(appId: number): boolean
18
- export function isDlcInstalled(appId: number): boolean
19
- export function isSubscribedFromFreeWeekend(): boolean
20
- export function isVacBanned(): boolean
21
- export function isCybercafe(): boolean
22
- export function isLowViolence(): boolean
23
- export function isSubscribed(): boolean
24
21
  export function appBuildId(): number
25
22
  export function appInstallDir(appId: number): string
26
23
  export function appOwner(): PlayerSteamId
27
24
  export function availableGameLanguages(): Array<string>
28
- export function currentGameLanguage(): string
29
25
  export function currentBetaName(): string | null
26
+ export function currentGameLanguage(): string
27
+ export function isAppInstalled(appId: number): boolean
28
+ export function isCybercafe(): boolean
29
+ export function isDlcInstalled(appId: number): boolean
30
+ export function isLowViolence(): boolean
31
+ export function isSubscribed(): boolean
32
+ export function isSubscribedApp(appId: number): boolean
33
+ export function isSubscribedFromFreeWeekend(): boolean
34
+ export function isVacBanned(): boolean
30
35
  }
36
+
31
37
  export declare namespace auth {
38
+ export class Ticket {
39
+ cancel(): void
40
+ getBytes(): Buffer
41
+ }
42
+ export function getAuthTicketForWebApi(identity: string, timeoutSeconds?: number | undefined | null): Promise<Ticket>
32
43
  /**
33
- * @param steamId64 - The user steam id or game server steam id. Use as NetworkIdentity of the remote system that will authenticate the ticket. If it is peer-to-peer then the user steam ID. If it is a game server, then the game server steam ID may be used if it was obtained from a trusted 3rd party
44
+ * @param ip - The string of IPv4 or IPv6 address. Use as NetworkIdentity of the remote system that will authenticate the ticket.
34
45
  * @param timeoutSeconds - The number of seconds to wait for the ticket to be validated. Default value is 10 seconds.
35
46
  */
36
- export function getSessionTicketWithSteamId(steamId64: bigint, timeoutSeconds?: number | undefined | null): Promise<Ticket>
47
+ export function getSessionTicketWithIp(ip: string, timeoutSeconds?: number | undefined | null): Promise<Ticket>
37
48
  /**
38
- * @param ip - The string of IPv4 or IPv6 address. Use as NetworkIdentity of the remote system that will authenticate the ticket.
49
+ * @param steamId64 - The user steam id or game server steam id. Use as NetworkIdentity of the remote system that will authenticate the ticket. If it is peer-to-peer then the user steam ID. If it is a game server, then the game server steam ID may be used if it was obtained from a trusted 3rd party
39
50
  * @param timeoutSeconds - The number of seconds to wait for the ticket to be validated. Default value is 10 seconds.
40
51
  */
41
- export function getSessionTicketWithIp(ip: string, timeoutSeconds?: number | undefined | null): Promise<Ticket>
42
- export function getAuthTicketForWebApi(identity: string, timeoutSeconds?: number | undefined | null): Promise<Ticket>
43
- export class Ticket {
44
- cancel(): void
45
- getBytes(): Buffer
46
- }
52
+ export function getSessionTicketWithSteamId(steamId64: bigint, timeoutSeconds?: number | undefined | null): Promise<Ticket>
47
53
  }
54
+
48
55
  export declare namespace callback {
56
+ export class Handle {
57
+ disconnect(): void
58
+ }
59
+ export function register<C extends keyof import('./callbacks').CallbackReturns>(steamCallback: C, handler: (value: import('./callbacks').CallbackReturns[C]) => void): Handle
49
60
  export const enum SteamCallback {
50
61
  PersonaStateChange = 0,
51
62
  SteamServersConnected = 1,
@@ -58,26 +69,459 @@ export declare namespace callback {
58
69
  GameLobbyJoinRequested = 8,
59
70
  MicroTxnAuthorizationResponse = 9
60
71
  }
61
- export function register<C extends keyof import('./callbacks').CallbackReturns>(steamCallback: C, handler: (value: import('./callbacks').CallbackReturns[C]) => void): Handle
62
- export class Handle {
63
- disconnect(): void
64
- }
65
72
  }
73
+
66
74
  export declare namespace cloud {
67
- export function isEnabledForAccount(): boolean
68
- export function isEnabledForApp(): boolean
69
- export function setEnabledForApp(enabled: boolean): void
70
- export function readFile(name: string): string
71
- export function writeFile(name: string, content: string): boolean
72
75
  export function deleteFile(name: string): boolean
73
76
  export function fileExists(name: string): boolean
74
- export function listFiles(): Array<FileInfo>
75
- export class FileInfo {
77
+ export interface FileInfo {
76
78
  name: string
77
79
  size: bigint
78
80
  }
81
+ export function isEnabledForAccount(): boolean
82
+ export function isEnabledForApp(): boolean
83
+ export function listFiles(): Array<FileInfo>
84
+ export function readFile(name: string): string
85
+ export function setEnabledForApp(enabled: boolean): void
86
+ export function writeFile(name: string, content: string): boolean
79
87
  }
88
+
80
89
  export declare namespace input {
90
+ export class Controller {
91
+ activateActionSet(actionSetHandle: bigint): void
92
+ isDigitalActionPressed(actionHandle: bigint): boolean
93
+ getAnalogActionVector(actionHandle: bigint): AnalogActionVector
94
+ getType(): InputType
95
+ getHandle(): bigint
96
+ /** Gets controller latest data, best use for low latency if you call this all the time */
97
+ runFrame(): void
98
+ /** Gets controller's motion sensors */
99
+ getMotionData(): MotionData | null
100
+ getFilePathForAction(actionHandle: InputActionOrigins): string
101
+ }
102
+ export interface AnalogActionVector {
103
+ x: number
104
+ y: number
105
+ }
106
+ export function getActionSet(actionSetName: string): bigint
107
+ export function getAnalogAction(actionName: string): bigint
108
+ export function getControllers(): Array<Controller>
109
+ export function getDigitalAction(actionName: string): bigint
110
+ export function init(): void
111
+ export const enum InputActionOrigins {
112
+ None = 0,
113
+ SteamControllerA = 1,
114
+ SteamControllerB = 2,
115
+ SteamControllerX = 3,
116
+ SteamControllerY = 4,
117
+ SteamControllerLeftBumper = 5,
118
+ SteamControllerRightBumper = 6,
119
+ SteamControllerLeftGrip = 7,
120
+ SteamControllerRightGrip = 8,
121
+ SteamControllerStart = 9,
122
+ SteamControllerBack = 10,
123
+ SteamControllerLeftPadTouch = 11,
124
+ SteamControllerLeftPadSwipe = 12,
125
+ SteamControllerLeftPadClick = 13,
126
+ SteamControllerLeftPadDPadNorth = 14,
127
+ SteamControllerLeftPadDPadSouth = 15,
128
+ SteamControllerLeftPadDPadWest = 16,
129
+ SteamControllerLeftPadDPadEast = 17,
130
+ SteamControllerRightPadTouch = 18,
131
+ SteamControllerRightPadSwipe = 19,
132
+ SteamControllerRightPadClick = 20,
133
+ SteamControllerRightPadDPadNorth = 21,
134
+ SteamControllerRightPadDPadSouth = 22,
135
+ SteamControllerRightPadDPadWest = 23,
136
+ SteamControllerRightPadDPadEast = 24,
137
+ SteamControllerLeftTriggerPull = 25,
138
+ SteamControllerLeftTriggerClick = 26,
139
+ SteamControllerRightTriggerPull = 27,
140
+ SteamControllerRightTriggerClick = 28,
141
+ SteamControllerLeftStickMove = 29,
142
+ SteamControllerLeftStickClick = 30,
143
+ SteamControllerLeftStickDPadNorth = 31,
144
+ SteamControllerLeftStickDPadSouth = 32,
145
+ SteamControllerLeftStickDPadWest = 33,
146
+ SteamControllerLeftStickDPadEast = 34,
147
+ SteamControllerGyroMove = 35,
148
+ SteamControllerGyroPitch = 36,
149
+ SteamControllerGyroYaw = 37,
150
+ SteamControllerGyroRoll = 38,
151
+ SteamControllerReserved0 = 39,
152
+ SteamControllerReserved1 = 40,
153
+ SteamControllerReserved2 = 41,
154
+ SteamControllerReserved3 = 42,
155
+ SteamControllerReserved4 = 43,
156
+ SteamControllerReserved5 = 44,
157
+ SteamControllerReserved6 = 45,
158
+ SteamControllerReserved7 = 46,
159
+ SteamControllerReserved8 = 47,
160
+ SteamControllerReserved9 = 48,
161
+ SteamControllerReserved10 = 49,
162
+ PS4X = 50,
163
+ PS4Circle = 51,
164
+ PS4Triangle = 52,
165
+ PS4Square = 53,
166
+ PS4LeftBumper = 54,
167
+ PS4RightBumper = 55,
168
+ PS4Options = 56,
169
+ PS4Share = 57,
170
+ PS4LeftPadTouch = 58,
171
+ PS4LeftPadSwipe = 59,
172
+ PS4LeftPadClick = 60,
173
+ PS4LeftPadDPadNorth = 61,
174
+ PS4LeftPadDPadSouth = 62,
175
+ PS4LeftPadDPadWest = 63,
176
+ PS4LeftPadDPadEast = 64,
177
+ PS4RightPadTouch = 65,
178
+ PS4RightPadSwipe = 66,
179
+ PS4RightPadClick = 67,
180
+ PS4RightPadDPadNorth = 68,
181
+ PS4RightPadDPadSouth = 69,
182
+ PS4RightPadDPadWest = 70,
183
+ PS4RightPadDPadEast = 71,
184
+ PS4CenterPadTouch = 72,
185
+ PS4CenterPadSwipe = 73,
186
+ PS4CenterPadClick = 74,
187
+ PS4CenterPadDPadNorth = 75,
188
+ PS4CenterPadDPadSouth = 76,
189
+ PS4CenterPadDPadWest = 77,
190
+ PS4CenterPadDPadEast = 78,
191
+ PS4LeftTriggerPull = 79,
192
+ PS4LeftTriggerClick = 80,
193
+ PS4RightTriggerPull = 81,
194
+ PS4RightTriggerClick = 82,
195
+ PS4LeftStickMove = 83,
196
+ PS4LeftStickClick = 84,
197
+ PS4LeftStickDPadNorth = 85,
198
+ PS4LeftStickDPadSouth = 86,
199
+ PS4LeftStickDPadWest = 87,
200
+ PS4LeftStickDPadEast = 88,
201
+ PS4RightStickMove = 89,
202
+ PS4RightStickClick = 90,
203
+ PS4RightStickDPadNorth = 91,
204
+ PS4RightStickDPadSouth = 92,
205
+ PS4RightStickDPadWest = 93,
206
+ PS4RightStickDPadEast = 94,
207
+ PS4DPadNorth = 95,
208
+ PS4DPadSouth = 96,
209
+ PS4DPadWest = 97,
210
+ PS4DPadEast = 98,
211
+ PS4GyroMove = 99,
212
+ PS4GyroPitch = 100,
213
+ PS4GyroYaw = 101,
214
+ PS4GyroRoll = 102,
215
+ PS4DPadMove = 103,
216
+ PS4Reserved1 = 104,
217
+ PS4Reserved2 = 105,
218
+ PS4Reserved3 = 106,
219
+ PS4Reserved4 = 107,
220
+ PS4Reserved5 = 108,
221
+ PS4Reserved6 = 109,
222
+ PS4Reserved7 = 110,
223
+ PS4Reserved8 = 111,
224
+ PS4Reserved9 = 112,
225
+ PS4Reserved10 = 113,
226
+ XBoxOneA = 114,
227
+ XBoxOneB = 115,
228
+ XBoxOneX = 116,
229
+ XBoxOneY = 117,
230
+ XBoxOneLeftBumper = 118,
231
+ XBoxOneRightBumper = 119,
232
+ XBoxOneMenu = 120,
233
+ XBoxOneView = 121,
234
+ XBoxOneLeftTriggerPull = 122,
235
+ XBoxOneLeftTriggerClick = 123,
236
+ XBoxOneRightTriggerPull = 124,
237
+ XBoxOneRightTriggerClick = 125,
238
+ XBoxOneLeftStickMove = 126,
239
+ XBoxOneLeftStickClick = 127,
240
+ XBoxOneLeftStickDPadNorth = 128,
241
+ XBoxOneLeftStickDPadSouth = 129,
242
+ XBoxOneLeftStickDPadWest = 130,
243
+ XBoxOneLeftStickDPadEast = 131,
244
+ XBoxOneRightStickMove = 132,
245
+ XBoxOneRightStickClick = 133,
246
+ XBoxOneRightStickDPadNorth = 134,
247
+ XBoxOneRightStickDPadSouth = 135,
248
+ XBoxOneRightStickDPadWest = 136,
249
+ XBoxOneRightStickDPadEast = 137,
250
+ XBoxOneDPadNorth = 138,
251
+ XBoxOneDPadSouth = 139,
252
+ XBoxOneDPadWest = 140,
253
+ XBoxOneDPadEast = 141,
254
+ XBoxOneDPadMove = 142,
255
+ XBoxOneLeftGripLower = 143,
256
+ XBoxOneLeftGripUpper = 144,
257
+ XBoxOneRightGripLower = 145,
258
+ XBoxOneRightGripUpper = 146,
259
+ XBoxOneShare = 147,
260
+ XBoxOneReserved6 = 148,
261
+ XBoxOneReserved7 = 149,
262
+ XBoxOneReserved8 = 150,
263
+ XBoxOneReserved9 = 151,
264
+ XBoxOneReserved10 = 152,
265
+ XBox360A = 153,
266
+ XBox360B = 154,
267
+ XBox360X = 155,
268
+ XBox360Y = 156,
269
+ XBox360LeftBumper = 157,
270
+ XBox360RightBumper = 158,
271
+ XBox360Start = 159,
272
+ XBox360Back = 160,
273
+ XBox360LeftTriggerPull = 161,
274
+ XBox360LeftTriggerClick = 162,
275
+ XBox360RightTriggerPull = 163,
276
+ XBox360RightTriggerClick = 164,
277
+ XBox360LeftStickMove = 165,
278
+ XBox360LeftStickClick = 166,
279
+ XBox360LeftStickDPadNorth = 167,
280
+ XBox360LeftStickDPadSouth = 168,
281
+ XBox360LeftStickDPadWest = 169,
282
+ XBox360LeftStickDPadEast = 170,
283
+ XBox360RightStickMove = 171,
284
+ XBox360RightStickClick = 172,
285
+ XBox360RightStickDPadNorth = 173,
286
+ XBox360RightStickDPadSouth = 174,
287
+ XBox360RightStickDPadWest = 175,
288
+ XBox360RightStickDPadEast = 176,
289
+ XBox360DPadNorth = 177,
290
+ XBox360DPadSouth = 178,
291
+ XBox360DPadWest = 179,
292
+ XBox360DPadEast = 180,
293
+ XBox360DPadMove = 181,
294
+ XBox360Reserved1 = 182,
295
+ XBox360Reserved2 = 183,
296
+ XBox360Reserved3 = 184,
297
+ XBox360Reserved4 = 185,
298
+ XBox360Reserved5 = 186,
299
+ XBox360Reserved6 = 187,
300
+ XBox360Reserved7 = 188,
301
+ XBox360Reserved8 = 189,
302
+ XBox360Reserved9 = 190,
303
+ XBox360Reserved10 = 191,
304
+ SwitchA = 192,
305
+ SwitchB = 193,
306
+ SwitchX = 194,
307
+ SwitchY = 195,
308
+ SwitchLeftBumper = 196,
309
+ SwitchRightBumper = 197,
310
+ SwitchPlus = 198,
311
+ SwitchMinus = 199,
312
+ SwitchCapture = 200,
313
+ SwitchLeftTriggerPull = 201,
314
+ SwitchLeftTriggerClick = 202,
315
+ SwitchRightTriggerPull = 203,
316
+ SwitchRightTriggerClick = 204,
317
+ SwitchLeftStickMove = 205,
318
+ SwitchLeftStickClick = 206,
319
+ SwitchLeftStickDPadNorth = 207,
320
+ SwitchLeftStickDPadSouth = 208,
321
+ SwitchLeftStickDPadWest = 209,
322
+ SwitchLeftStickDPadEast = 210,
323
+ SwitchRightStickMove = 211,
324
+ SwitchRightStickClick = 212,
325
+ SwitchRightStickDPadNorth = 213,
326
+ SwitchRightStickDPadSouth = 214,
327
+ SwitchRightStickDPadWest = 215,
328
+ SwitchRightStickDPadEast = 216,
329
+ SwitchDPadNorth = 217,
330
+ SwitchDPadSouth = 218,
331
+ SwitchDPadWest = 219,
332
+ SwitchDPadEast = 220,
333
+ SwitchProGyroMove = 221,
334
+ SwitchProGyroPitch = 222,
335
+ SwitchProGyroYaw = 223,
336
+ SwitchProGyroRoll = 224,
337
+ SwitchDPadMove = 225,
338
+ SwitchReserved1 = 226,
339
+ SwitchReserved2 = 227,
340
+ SwitchReserved3 = 228,
341
+ SwitchReserved4 = 229,
342
+ SwitchReserved5 = 230,
343
+ SwitchReserved6 = 231,
344
+ SwitchReserved7 = 232,
345
+ SwitchReserved8 = 233,
346
+ SwitchReserved9 = 234,
347
+ SwitchReserved10 = 235,
348
+ SwitchRightGyroMove = 236,
349
+ SwitchRightGyroPitch = 237,
350
+ SwitchRightGyroYaw = 238,
351
+ SwitchRightGyroRoll = 239,
352
+ SwitchLeftGyroMove = 240,
353
+ SwitchLeftGyroPitch = 241,
354
+ SwitchLeftGyroYaw = 242,
355
+ SwitchLeftGyroRoll = 243,
356
+ SwitchLeftGripLower = 244,
357
+ SwitchLeftGripUpper = 245,
358
+ SwitchRightGripLower = 246,
359
+ SwitchRightGripUpper = 247,
360
+ SwitchJoyConButtonN = 248,
361
+ SwitchJoyConButtonE = 249,
362
+ SwitchJoyConButtonS = 250,
363
+ SwitchJoyConButtonW = 251,
364
+ SwitchReserved15 = 252,
365
+ SwitchReserved16 = 253,
366
+ SwitchReserved17 = 254,
367
+ SwitchReserved18 = 255,
368
+ SwitchReserved19 = 256,
369
+ SwitchReserved20 = 257,
370
+ PS5X = 258,
371
+ PS5Circle = 259,
372
+ PS5Triangle = 260,
373
+ PS5Square = 261,
374
+ PS5LeftBumper = 262,
375
+ PS5RightBumper = 263,
376
+ PS5Option = 264,
377
+ PS5Create = 265,
378
+ PS5Mute = 266,
379
+ PS5LeftPadTouch = 267,
380
+ PS5LeftPadSwipe = 268,
381
+ PS5LeftPadClick = 269,
382
+ PS5LeftPadDPadNorth = 270,
383
+ PS5LeftPadDPadSouth = 271,
384
+ PS5LeftPadDPadWest = 272,
385
+ PS5LeftPadDPadEast = 273,
386
+ PS5RightPadTouch = 274,
387
+ PS5RightPadSwipe = 275,
388
+ PS5RightPadClick = 276,
389
+ PS5RightPadDPadNorth = 277,
390
+ PS5RightPadDPadSouth = 278,
391
+ PS5RightPadDPadWest = 279,
392
+ PS5RightPadDPadEast = 280,
393
+ PS5CenterPadTouch = 281,
394
+ PS5CenterPadSwipe = 282,
395
+ PS5CenterPadClick = 283,
396
+ PS5CenterPadDPadNorth = 284,
397
+ PS5CenterPadDPadSouth = 285,
398
+ PS5CenterPadDPadWest = 286,
399
+ PS5CenterPadDPadEast = 287,
400
+ PS5LeftTriggerPull = 288,
401
+ PS5LeftTriggerClick = 289,
402
+ PS5RightTriggerPull = 290,
403
+ PS5RightTriggerClick = 291,
404
+ PS5LeftStickMove = 292,
405
+ PS5LeftStickClick = 293,
406
+ PS5LeftStickDPadNorth = 294,
407
+ PS5LeftStickDPadSouth = 295,
408
+ PS5LeftStickDPadWest = 296,
409
+ PS5LeftStickDPadEast = 297,
410
+ PS5RightStickMove = 298,
411
+ PS5RightStickClick = 299,
412
+ PS5RightStickDPadNorth = 300,
413
+ PS5RightStickDPadSouth = 301,
414
+ PS5RightStickDPadWest = 302,
415
+ PS5RightStickDPadEast = 303,
416
+ PS5DPadNorth = 304,
417
+ PS5DPadSouth = 305,
418
+ PS5DPadWest = 306,
419
+ PS5DPadEast = 307,
420
+ PS5GyroMove = 308,
421
+ PS5GyroPitch = 309,
422
+ PS5GyroYaw = 310,
423
+ PS5GyroRoll = 311,
424
+ PS5DPadMove = 312,
425
+ PS5LeftGrip = 313,
426
+ PS5RightGrip = 314,
427
+ PS5LeftFn = 315,
428
+ PS5RightFn = 316,
429
+ PS5Reserved5 = 317,
430
+ PS5Reserved6 = 318,
431
+ PS5Reserved7 = 319,
432
+ PS5Reserved8 = 320,
433
+ PS5Reserved9 = 321,
434
+ PS5Reserved10 = 322,
435
+ PS5Reserved11 = 323,
436
+ PS5Reserved12 = 324,
437
+ PS5Reserved13 = 325,
438
+ PS5Reserved14 = 326,
439
+ PS5Reserved15 = 327,
440
+ PS5Reserved16 = 328,
441
+ PS5Reserved17 = 329,
442
+ PS5Reserved18 = 330,
443
+ PS5Reserved19 = 331,
444
+ PS5Reserved20 = 332,
445
+ SteamDeckA = 333,
446
+ SteamDeckB = 334,
447
+ SteamDeckX = 335,
448
+ SteamDeckY = 336,
449
+ SteamDeckL1 = 337,
450
+ SteamDeckR1 = 338,
451
+ SteamDeckMenu = 339,
452
+ SteamDeckView = 340,
453
+ SteamDeckLeftPadTouch = 341,
454
+ SteamDeckLeftPadSwipe = 342,
455
+ SteamDeckLeftPadClick = 343,
456
+ SteamDeckLeftPadDPadNorth = 344,
457
+ SteamDeckLeftPadDPadSouth = 345,
458
+ SteamDeckLeftPadDPadWest = 346,
459
+ SteamDeckLeftPadDPadEast = 347,
460
+ SteamDeckRightPadTouch = 348,
461
+ SteamDeckRightPadSwipe = 349,
462
+ SteamDeckRightPadClick = 350,
463
+ SteamDeckRightPadDPadNorth = 351,
464
+ SteamDeckRightPadDPadSouth = 352,
465
+ SteamDeckRightPadDPadWest = 353,
466
+ SteamDeckRightPadDPadEast = 354,
467
+ SteamDeckL2SoftPull = 355,
468
+ SteamDeckL2 = 356,
469
+ SteamDeckR2SoftPull = 357,
470
+ SteamDeckR2 = 358,
471
+ SteamDeckLeftStickMove = 359,
472
+ SteamDeckL3 = 360,
473
+ SteamDeckLeftStickDPadNorth = 361,
474
+ SteamDeckLeftStickDPadSouth = 362,
475
+ SteamDeckLeftStickDPadWest = 363,
476
+ SteamDeckLeftStickDPadEast = 364,
477
+ SteamDeckLeftStickTouch = 365,
478
+ SteamDeckRightStickMove = 366,
479
+ SteamDeckR3 = 367,
480
+ SteamDeckRightStickDPadNorth = 368,
481
+ SteamDeckRightStickDPadSouth = 369,
482
+ SteamDeckRightStickDPadWest = 370,
483
+ SteamDeckRightStickDPadEast = 371,
484
+ SteamDeckRightStickTouch = 372,
485
+ SteamDeckL4 = 373,
486
+ SteamDeckR4 = 374,
487
+ SteamDeckL5 = 375,
488
+ SteamDeckR5 = 376,
489
+ SteamDeckDPadMove = 377,
490
+ SteamDeckDPadNorth = 378,
491
+ SteamDeckDPadSouth = 379,
492
+ SteamDeckDPadWest = 380,
493
+ SteamDeckDPadEast = 381,
494
+ SteamDeckGyroMove = 382,
495
+ SteamDeckGyroPitch = 383,
496
+ SteamDeckGyroYaw = 384,
497
+ SteamDeckGyroRoll = 385,
498
+ SteamDeckReserved1 = 386,
499
+ SteamDeckReserved2 = 387,
500
+ SteamDeckReserved3 = 388,
501
+ SteamDeckReserved4 = 389,
502
+ SteamDeckReserved5 = 390,
503
+ SteamDeckReserved6 = 391,
504
+ SteamDeckReserved7 = 392,
505
+ SteamDeckReserved8 = 393,
506
+ SteamDeckReserved9 = 394,
507
+ SteamDeckReserved10 = 395,
508
+ SteamDeckReserved11 = 396,
509
+ SteamDeckReserved12 = 397,
510
+ SteamDeckReserved13 = 398,
511
+ SteamDeckReserved14 = 399,
512
+ SteamDeckReserved15 = 400,
513
+ SteamDeckReserved16 = 401,
514
+ SteamDeckReserved17 = 402,
515
+ SteamDeckReserved18 = 403,
516
+ SteamDeckReserved19 = 404,
517
+ SteamDeckReserved20 = 405,
518
+ HoripadM1 = 406,
519
+ HoripadM2 = 407,
520
+ HoripadL4 = 408,
521
+ HoripadR4 = 409,
522
+ Count = 410,
523
+ MaximumPossibleValue = 32767
524
+ }
81
525
  export const enum InputType {
82
526
  Unknown = 'Unknown',
83
527
  SteamController = 'SteamController',
@@ -117,46 +561,19 @@ export declare namespace input {
117
561
  /** Rotational Velocity Z axis */
118
562
  rotVelZ: number
119
563
  }
120
- export interface AnalogActionVector {
121
- x: number
122
- y: number
123
- }
124
- export function init(): void
125
- export function getControllers(): Array<Controller>
126
- export function getActionSet(actionSetName: string): bigint
127
- export function getDigitalAction(actionName: string): bigint
128
- export function getAnalogAction(actionName: string): bigint
129
564
  export function shutdown(): void
130
- export class Controller {
131
- activateActionSet(actionSetHandle: bigint): void
132
- isDigitalActionPressed(actionHandle: bigint): boolean
133
- getAnalogActionVector(actionHandle: bigint): AnalogActionVector
134
- getType(): InputType
135
- getHandle(): bigint
136
- /** Gets controller latest data, best use for low latency if you call this all the time */
137
- runFrame(): void
138
- /** Gets controller's motion sensors */
139
- getMotionData(): MotionData | null
140
- }
141
565
  }
566
+
142
567
  export declare namespace localplayer {
143
- export function getSteamId(): PlayerSteamId
144
- export function getName(): string
145
- export function getLevel(): number
146
568
  /** @returns the 2 digit ISO 3166-1-alpha-2 format country code which client is running in, e.g. "US" or "UK". */
147
569
  export function getIpCountry(): string
570
+ export function getLevel(): number
571
+ export function getName(): string
572
+ export function getSteamId(): PlayerSteamId
148
573
  export function setRichPresence(key: string, value?: string | undefined | null): void
149
574
  }
575
+
150
576
  export declare namespace matchmaking {
151
- export const enum LobbyType {
152
- Private = 0,
153
- FriendsOnly = 1,
154
- Public = 2,
155
- Invisible = 3
156
- }
157
- export function createLobby(lobbyType: LobbyType, maxMembers: number): Promise<Lobby>
158
- export function joinLobby(lobbyId: bigint): Promise<Lobby>
159
- export function getLobbies(): Promise<Array<Lobby>>
160
577
  export class Lobby {
161
578
  join(): Promise<Lobby>
162
579
  leave(): void
@@ -176,17 +593,30 @@ export declare namespace matchmaking {
176
593
  * @returns true if all data was set successfully
177
594
  */
178
595
  mergeFullData(data: Record<string, string>): boolean
179
-
180
- id(): BigInt
181
- idAsU64(): number
596
+ get id(): bigint
597
+ get idAsU64(): bigint
598
+ }
599
+ export function createLobby(lobbyType: LobbyType, maxMembers: number): Promise<Lobby>
600
+ export function getLobbies(): Promise<Array<Lobby>>
601
+ export function joinLobby(lobbyId: bigint): Promise<Lobby>
602
+ export const enum LobbyType {
603
+ Private = 0,
604
+ FriendsOnly = 1,
605
+ Public = 2,
606
+ Invisible = 3
182
607
  }
183
608
  }
609
+
184
610
  export declare namespace networking {
611
+ export function acceptP2PSession(steamId64: bigint): void
612
+ export function isP2PPacketAvailable(): number
185
613
  export interface P2PPacket {
186
614
  data: Buffer
187
615
  size: number
188
616
  steamId: PlayerSteamId
189
617
  }
618
+ export function readP2PPacket(size: number): P2PPacket
619
+ export function sendP2PPacket(steamId64: bigint, sendType: SendType, data: Buffer): boolean
190
620
  /** The method used to send a packet */
191
621
  export const enum SendType {
192
622
  /**
@@ -212,12 +642,14 @@ export declare namespace networking {
212
642
  */
213
643
  ReliableWithBuffering = 3
214
644
  }
215
- export function sendP2PPacket(steamId64: bigint, sendType: SendType, data: Buffer): boolean
216
- export function isP2PPacketAvailable(): number
217
- export function readP2PPacket(size: number): P2PPacket
218
- export function acceptP2PSession(steamId64: bigint): void
219
645
  }
646
+
220
647
  export declare namespace overlay {
648
+ export function activateDialog(dialog: Dialog): void
649
+ export function activateDialogToUser(dialog: Dialog, steamId64: bigint): void
650
+ export function activateInviteDialog(lobbyId: bigint): void
651
+ export function activateToStore(appId: number, flag: StoreFlag): void
652
+ export function activateToWebPage(url: string): void
221
653
  export const enum Dialog {
222
654
  Friends = 0,
223
655
  Community = 1,
@@ -232,108 +664,76 @@ export declare namespace overlay {
232
664
  AddToCart = 1,
233
665
  AddToCartAndShow = 2
234
666
  }
235
- export function activateDialog(dialog: Dialog): void
236
- export function activateDialogToUser(dialog: Dialog, steamId64: bigint): void
237
- export function activateInviteDialog(lobbyId: bigint): void
238
- export function activateToWebPage(url: string): void
239
- export function activateToStore(appId: number, flag: StoreFlag): void
240
667
  }
668
+
241
669
  export declare namespace stats {
242
670
  export function getInt(name: string): number | null
671
+ export function resetAll(achievementsToo: boolean): boolean
243
672
  export function setInt(name: string, value: number): boolean
244
673
  export function store(): boolean
245
- export function resetAll(achievementsToo: boolean): boolean
246
674
  }
675
+
247
676
  export declare namespace utils {
248
- export function getAppId(): number
249
- export function getServerRealTime(): number
250
- export function isSteamRunningOnSteamDeck(): boolean
251
- export const enum GamepadTextInputMode {
252
- Normal = 0,
253
- Password = 1
254
- }
255
- export const enum GamepadTextInputLineMode {
256
- SingleLine = 0,
257
- MultipleLines = 1
258
- }
259
- /** @returns the entered text, or null if cancelled or could not show the input */
260
- export function showGamepadTextInput(inputMode: GamepadTextInputMode, inputLineMode: GamepadTextInputLineMode, description: string, maxCharacters: number, existingText?: string | undefined | null): Promise<string | null>
261
677
  export const enum FloatingGamepadTextInputMode {
262
678
  SingleLine = 0,
263
679
  MultipleLines = 1,
264
680
  Email = 2,
265
681
  Numeric = 3
266
682
  }
683
+ export const enum GamepadTextInputLineMode {
684
+ SingleLine = 0,
685
+ MultipleLines = 1
686
+ }
687
+ export const enum GamepadTextInputMode {
688
+ Normal = 0,
689
+ Password = 1
690
+ }
691
+ export function getAppId(): number
692
+ export function getServerRealTime(): number
693
+ export function isSteamRunningOnSteamDeck(): boolean
267
694
  /** @returns true if the floating keyboard was shown, otherwise, false */
268
695
  export function showFloatingGamepadTextInput(keyboardMode: FloatingGamepadTextInputMode, x: number, y: number, width: number, height: number): Promise<boolean>
696
+ /** @returns the entered text, or null if cancelled or could not show the input */
697
+ export function showGamepadTextInput(inputMode: GamepadTextInputMode, inputLineMode: GamepadTextInputLineMode, description: string, maxCharacters: number, existingText?: string | undefined | null): Promise<string | null>
269
698
  }
699
+
270
700
  export declare namespace workshop {
271
- export interface UgcResult {
272
- itemId: bigint
273
- needsToAcceptAgreement: boolean
274
- }
275
- export const enum UgcItemVisibility {
276
- Public = 0,
277
- FriendsOnly = 1,
278
- Private = 2,
279
- Unlisted = 3
280
- }
281
- export interface UgcUpdate {
282
- title?: string
283
- description?: string
284
- changeNote?: string
285
- previewPath?: string
286
- contentPath?: string
287
- tags?: Array<string>
288
- visibility?: UgcItemVisibility
289
- }
290
- export interface InstallInfo {
291
- folder: string
292
- sizeOnDisk: bigint
293
- timestamp: number
294
- }
295
- export interface DownloadInfo {
296
- current: bigint
297
- total: bigint
298
- }
299
- export const enum UpdateStatus {
300
- Invalid = 0,
301
- PreparingConfig = 1,
302
- PreparingContent = 2,
303
- UploadingContent = 3,
304
- UploadingPreviewFile = 4,
305
- CommittingChanges = 5
306
- }
307
- export interface UpdateProgress {
308
- status: UpdateStatus
309
- progress: bigint
310
- total: bigint
701
+ export interface AppIDs {
702
+ creator?: number
703
+ consumer?: number
311
704
  }
312
705
  export function createItem(appId?: number | undefined | null): Promise<UgcResult>
313
- export function updateItem(itemId: bigint, updateDetails: UgcUpdate, appId?: number | undefined | null): Promise<UgcResult>
314
- export function updateItemWithCallback(itemId: bigint, updateDetails: UgcUpdate, appId: number | undefined | null, successCallback: (data: UgcResult) => void, errorCallback: (err: any) => void, progressCallback?: (data: UpdateProgress) => void, progressCallbackIntervalMs?: number | undefined | null): void
706
+ export function deleteItem(itemId: bigint): Promise<void>
315
707
  /**
316
- * Subscribe to a workshop item. It will be downloaded and installed as soon as possible.
708
+ * Download or update a workshop item.
317
709
  *
318
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#SubscribeItem}
319
- */
320
- export function subscribe(itemId: bigint): Promise<void>
321
- /**
322
- * Unsubscribe from a workshop item. This will result in the item being removed after the game quits.
710
+ * @param highPriority - If high priority is true, start the download in high priority mode, pausing any existing in-progress Steam downloads and immediately begin downloading this workshop item.
711
+ * @returns true or false
323
712
  *
324
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#UnsubscribeItem}
713
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#DownloadItem}
325
714
  */
326
- export function unsubscribe(itemId: bigint): Promise<void>
715
+ export function download(itemId: bigint, highPriority: boolean): boolean
327
716
  /**
328
- * Gets the current state of a workshop item on this client. States can be combined.
717
+ * Get info about a pending download of a workshop item.
329
718
  *
330
- * @returns a number with the current item state, e.g. 9
331
- * 9 = 1 (The current user is subscribed to this item) + 8 (The item needs an update)
719
+ * @returns an object with the properties {current, total}
332
720
  *
333
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#GetItemState}
334
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#EItemState}
721
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#GetItemDownloadInfo}
335
722
  */
336
- export function state(itemId: bigint): number
723
+ export function downloadInfo(itemId: bigint): DownloadInfo | null
724
+ export interface DownloadInfo {
725
+ current: bigint
726
+ total: bigint
727
+ }
728
+ export function getAllItems(page: number, queryType: UGCQueryType, itemType: UGCType, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
729
+ export function getItem(item: bigint, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItem | null>
730
+ export function getItems(items: Array<bigint>, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItemsResult>
731
+ /**
732
+ * Get all subscribed workshop items.
733
+ * @returns an array of subscribed workshop item ids
734
+ */
735
+ export function getSubscribedItems(): Array<bigint>
736
+ export function getUserItems(page: number, accountId: number, listType: UserListType, itemType: UGCType, sortOrder: UserListOrder, appIds: AppIDs, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
337
737
  /**
338
738
  * Gets info about currently installed content on the disc for workshop item.
339
739
  *
@@ -342,29 +742,33 @@ export declare namespace workshop {
342
742
  * {@link https://partner.steamgames.com/doc/api/ISteamUGC#GetItemInstallInfo}
343
743
  */
344
744
  export function installInfo(itemId: bigint): InstallInfo | null
745
+ export interface InstallInfo {
746
+ folder: string
747
+ sizeOnDisk: bigint
748
+ timestamp: number
749
+ }
345
750
  /**
346
- * Get info about a pending download of a workshop item.
751
+ * Gets the current state of a workshop item on this client. States can be combined.
347
752
  *
348
- * @returns an object with the properties {current, total}
753
+ * @returns a number with the current item state, e.g. 9
754
+ * 9 = 1 (The current user is subscribed to this item) + 8 (The item needs an update)
349
755
  *
350
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#GetItemDownloadInfo}
756
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#GetItemState}
757
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#EItemState}
351
758
  */
352
- export function downloadInfo(itemId: bigint): DownloadInfo | null
759
+ export function state(itemId: bigint): number
353
760
  /**
354
- * Download or update a workshop item.
355
- *
356
- * @param highPriority - If high priority is true, start the download in high priority mode, pausing any existing in-progress Steam downloads and immediately begin downloading this workshop item.
357
- * @returns true or false
761
+ * Subscribe to a workshop item. It will be downloaded and installed as soon as possible.
358
762
  *
359
- * {@link https://partner.steamgames.com/doc/api/ISteamUGC#DownloadItem}
360
- */
361
- export function download(itemId: bigint, highPriority: boolean): boolean
362
- /**
363
- * Get all subscribed workshop items.
364
- * @returns an array of subscribed workshop item ids
763
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#SubscribeItem}
365
764
  */
366
- export function getSubscribedItems(): Array<bigint>
367
- export function deleteItem(itemId: bigint): Promise<void>
765
+ export function subscribe(itemId: bigint): Promise<void>
766
+ export const enum UgcItemVisibility {
767
+ Public = 0,
768
+ FriendsOnly = 1,
769
+ Private = 2,
770
+ Unlisted = 3
771
+ }
368
772
  export const enum UGCQueryType {
369
773
  RankedByVote = 0,
370
774
  RankedByPublicationDate = 1,
@@ -387,6 +791,10 @@ export declare namespace workshop {
387
791
  RankedByLifetimePlaytimeSessions = 18,
388
792
  RankedByLastUpdatedDate = 19
389
793
  }
794
+ export interface UgcResult {
795
+ itemId: bigint
796
+ needsToAcceptAgreement: boolean
797
+ }
390
798
  export const enum UGCType {
391
799
  Items = 0,
392
800
  ItemsMtx = 1,
@@ -403,15 +811,35 @@ export declare namespace workshop {
403
811
  GameManagedItems = 12,
404
812
  All = 13
405
813
  }
406
- export const enum UserListType {
407
- Published = 0,
408
- VotedOn = 1,
409
- VotedUp = 2,
410
- VotedDown = 3,
411
- Favorited = 4,
412
- Subscribed = 5,
413
- UsedOrPlayed = 6,
414
- Followed = 7
814
+ export interface UgcUpdate {
815
+ title?: string
816
+ description?: string
817
+ changeNote?: string
818
+ previewPath?: string
819
+ contentPath?: string
820
+ tags?: Array<string>
821
+ visibility?: UgcItemVisibility
822
+ }
823
+ /**
824
+ * Unsubscribe from a workshop item. This will result in the item being removed after the game quits.
825
+ *
826
+ * {@link https://partner.steamgames.com/doc/api/ISteamUGC#UnsubscribeItem}
827
+ */
828
+ export function unsubscribe(itemId: bigint): Promise<void>
829
+ export function updateItem(itemId: bigint, updateDetails: UgcUpdate, appId?: number | undefined | null): Promise<UgcResult>
830
+ export function updateItemWithCallback(itemId: bigint, updateDetails: UgcUpdate, appId: number | undefined | null, successCallback: (data: UgcResult) => void, errorCallback: (err: any) => void, progressCallback?: (data: UpdateProgress) => void, progressCallbackIntervalMs?: number | undefined | null): void
831
+ export interface UpdateProgress {
832
+ status: UpdateStatus
833
+ progress: bigint
834
+ total: bigint
835
+ }
836
+ export const enum UpdateStatus {
837
+ Invalid = 0,
838
+ PreparingConfig = 1,
839
+ PreparingContent = 2,
840
+ UploadingContent = 3,
841
+ UploadingPreviewFile = 4,
842
+ CommittingChanges = 5
415
843
  }
416
844
  export const enum UserListOrder {
417
845
  CreationOrderAsc = 0,
@@ -422,20 +850,15 @@ export declare namespace workshop {
422
850
  VoteScoreDesc = 5,
423
851
  ForModeration = 6
424
852
  }
425
- export interface WorkshopItemStatistic {
426
- numSubscriptions?: bigint
427
- numFavorites?: bigint
428
- numFollowers?: bigint
429
- numUniqueSubscriptions?: bigint
430
- numUniqueFavorites?: bigint
431
- numUniqueFollowers?: bigint
432
- numUniqueWebsiteViews?: bigint
433
- reportScore?: bigint
434
- numSecondsPlayed?: bigint
435
- numPlaytimeSessions?: bigint
436
- numComments?: bigint
437
- numSecondsPlayedDuringTimePeriod?: bigint
438
- numPlaytimeSessionsDuringTimePeriod?: bigint
853
+ export const enum UserListType {
854
+ Published = 0,
855
+ VotedOn = 1,
856
+ VotedUp = 2,
857
+ VotedDown = 3,
858
+ Favorited = 4,
859
+ Subscribed = 5,
860
+ UsedOrPlayed = 6,
861
+ Followed = 7
439
862
  }
440
863
  export interface WorkshopItem {
441
864
  publishedFileId: bigint
@@ -462,16 +885,6 @@ export declare namespace workshop {
462
885
  previewUrl?: string
463
886
  statistics: WorkshopItemStatistic
464
887
  }
465
- export interface WorkshopPaginatedResult {
466
- items: Array<WorkshopItem | undefined | null>
467
- returnedResults: number
468
- totalResults: number
469
- wasCached: boolean
470
- }
471
- export interface WorkshopItemsResult {
472
- items: Array<WorkshopItem | undefined | null>
473
- wasCached: boolean
474
- }
475
888
  export interface WorkshopItemQueryConfig {
476
889
  cachedResponseMaxAge?: number
477
890
  includeMetadata?: boolean
@@ -486,12 +899,29 @@ export declare namespace workshop {
486
899
  searchText?: string
487
900
  rankedByTrendDays?: number
488
901
  }
489
- export interface AppIDs {
490
- creator?: number
491
- consumer?: number
902
+ export interface WorkshopItemsResult {
903
+ items: Array<WorkshopItem | undefined | null>
904
+ wasCached: boolean
905
+ }
906
+ export interface WorkshopItemStatistic {
907
+ numSubscriptions?: bigint
908
+ numFavorites?: bigint
909
+ numFollowers?: bigint
910
+ numUniqueSubscriptions?: bigint
911
+ numUniqueFavorites?: bigint
912
+ numUniqueFollowers?: bigint
913
+ numUniqueWebsiteViews?: bigint
914
+ reportScore?: bigint
915
+ numSecondsPlayed?: bigint
916
+ numPlaytimeSessions?: bigint
917
+ numComments?: bigint
918
+ numSecondsPlayedDuringTimePeriod?: bigint
919
+ numPlaytimeSessionsDuringTimePeriod?: bigint
920
+ }
921
+ export interface WorkshopPaginatedResult {
922
+ items: Array<WorkshopItem | undefined | null>
923
+ returnedResults: number
924
+ totalResults: number
925
+ wasCached: boolean
492
926
  }
493
- export function getItem(item: bigint, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItem | null>
494
- export function getItems(items: Array<bigint>, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopItemsResult>
495
- export function getAllItems(page: number, queryType: UGCQueryType, itemType: UGCType, creatorAppId: number, consumerAppId: number, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
496
- export function getUserItems(page: number, accountId: number, listType: UserListType, itemType: UGCType, sortOrder: UserListOrder, appIds: AppIDs, queryConfig?: WorkshopItemQueryConfig | undefined | null): Promise<WorkshopPaginatedResult>
497
927
  }