@indiegems/gem-web-sdk 12.0.0 → 13.1.0
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/CHANGELOG.md +37 -0
- package/dist/function.d.ts +9 -1
- package/dist/game.d.ts +52 -13
- package/dist/gem-web-sdk.bridge.js +1 -1
- package/dist/gem-web-sdk.esm.js +2 -2
- package/dist/gem-web-sdk.function.js +2 -2
- package/dist/gem-web-sdk.game.js +2 -2
- package/dist/gem-web-sdk.min.js +2 -2
- package/dist/gem-web-sdk.sdk.js +2 -2
- package/dist/gem-web-sdk.server-api.js +1 -1
- package/dist/gem-web-sdk.server.js +2 -2
- package/dist/index.d.ts +47 -14
- package/dist/sdk.d.ts +62 -14
- package/dist/server-api.d.ts +9 -1
- package/dist/server.d.ts +10 -1
- package/docs/api/api-reference-function.md +170 -2
- package/docs/api/api-reference-game.md +707 -162
- package/docs/api/api-reference-server.md +1 -1
- package/docs/api/reference.json +943 -172
- package/docs/arcade-avatars.md +471 -0
- package/docs/brand-art.md +3 -3
- package/docs/changelog.md +37 -0
- package/docs/getting-started.md +3 -2
- package/docs/inventory-and-catalogs.md +1 -1
- package/docs/manifest.json +19 -14
- package/docs/saving-player-progress.md +16 -10
- package/docs/server-bundles.md +2 -2
- package/docs/what-a-game-must-do.md +146 -99
- package/package.json +4 -2
- package/rigs/adult_human.glb +0 -0
- package/schema/bridge.v1.json +247 -20
- package/schema/capabilities.public.json +12 -0
package/dist/index.d.ts
CHANGED
|
@@ -64,6 +64,7 @@ declare const FRAME_TO_PARENT: readonly [
|
|
|
64
64
|
"gem.walletDisplay",
|
|
65
65
|
"gem.controlsDeclare",
|
|
66
66
|
"gem.menu",
|
|
67
|
+
"gem.gemCorner",
|
|
67
68
|
"gem.requestShare",
|
|
68
69
|
"gem.requestAvatarPicker",
|
|
69
70
|
"gem.vibrate",
|
|
@@ -71,12 +72,13 @@ declare const FRAME_TO_PARENT: readonly [
|
|
|
71
72
|
"gem.portraitBorders",
|
|
72
73
|
"gem.error",
|
|
73
74
|
"gem.requestPurchase",
|
|
75
|
+
"gem.requestAvatar3dPurchase",
|
|
74
76
|
"gem.deviceSettings.put",
|
|
75
77
|
"gem.requestAd",
|
|
76
78
|
"gem.requestSignIn",
|
|
77
79
|
"gem.requestFriendChallenge"
|
|
78
80
|
];
|
|
79
|
-
type GemCapability = "ads" | "signIn" | "purchases" | "friendChallenges" | "devtools" | "screenshot" | "feedbackContext" | "rooms" | "p2p" | "dedicated" | "clusterTarget" | "parties" | "autoStartFailure" | "ticketEvents" | "partySeating" | "socketState" | "audioState" | "rewardCue" | "frameStats" | "portraitBorders" | "engagement" | "viewport" | "reservedAreas" | "walletDisplay" | "localHost" | "cohorts" | "earnAllowance" | "deviceSettings" | "asyncOpponents" | "share" | "avatarPicker" | "vibration" | "gameMenu" | "controls";
|
|
81
|
+
type GemCapability = "ads" | "signIn" | "purchases" | "avatar3dPurchases" | "friendChallenges" | "devtools" | "screenshot" | "feedbackContext" | "rooms" | "p2p" | "dedicated" | "clusterTarget" | "parties" | "autoStartFailure" | "ticketEvents" | "partySeating" | "socketState" | "audioState" | "rewardCue" | "frameStats" | "portraitBorders" | "engagement" | "viewport" | "reservedAreas" | "walletDisplay" | "localHost" | "cohorts" | "earnAllowance" | "deviceSettings" | "asyncOpponents" | "share" | "avatarPicker" | "vibration" | "gameMenu" | "controls" | "gemCorner";
|
|
80
82
|
declare const CAPABILITY_GATES: Readonly<Record<string, string>>;
|
|
81
83
|
declare const CAPABILITY_NAMESPACE_GATES: ReadonlyArray<readonly [
|
|
82
84
|
string,
|
|
@@ -140,6 +142,12 @@ interface GemPlayer {
|
|
|
140
142
|
readonly avatar3dId?: string;
|
|
141
143
|
readonly avatar3dModelUrl?: string;
|
|
142
144
|
readonly avatar3dIconUrl?: string;
|
|
145
|
+
readonly avatars3d?: {
|
|
146
|
+
family: string;
|
|
147
|
+
id: string;
|
|
148
|
+
modelUrl: string;
|
|
149
|
+
iconUrl: string;
|
|
150
|
+
}[];
|
|
143
151
|
readonly badges?: {
|
|
144
152
|
itemId: string;
|
|
145
153
|
iconUrl: string;
|
|
@@ -434,6 +442,11 @@ interface GemMenuSelect {
|
|
|
434
442
|
readonly entry: "settings" | "item";
|
|
435
443
|
readonly id?: string;
|
|
436
444
|
}
|
|
445
|
+
interface GemGemCorner {
|
|
446
|
+
readonly gem: typeof PROTOCOL;
|
|
447
|
+
readonly type: "gem.gemCorner";
|
|
448
|
+
readonly corner: "top-left" | "top-right" | "bottom-left" | "bottom-right";
|
|
449
|
+
}
|
|
437
450
|
interface GemRequestShare {
|
|
438
451
|
readonly gem: typeof PROTOCOL;
|
|
439
452
|
readonly type: "gem.requestShare";
|
|
@@ -479,6 +492,13 @@ interface GemRequestPurchase {
|
|
|
479
492
|
readonly quantity?: number;
|
|
480
493
|
readonly catalogId?: string;
|
|
481
494
|
}
|
|
495
|
+
interface GemRequestAvatar3dPurchase {
|
|
496
|
+
readonly gem: typeof PROTOCOL;
|
|
497
|
+
readonly type: "gem.requestAvatar3dPurchase";
|
|
498
|
+
readonly requestId: string;
|
|
499
|
+
readonly itemId: string;
|
|
500
|
+
readonly currencySlug: string;
|
|
501
|
+
}
|
|
482
502
|
interface GemPurchaseResult {
|
|
483
503
|
readonly gem: typeof PROTOCOL;
|
|
484
504
|
readonly type: "gem.purchaseResult";
|
|
@@ -544,7 +564,7 @@ interface GemFriendChallengeResult {
|
|
|
544
564
|
readonly detail?: string;
|
|
545
565
|
}
|
|
546
566
|
type ParentMessage = GemHandshake | GemToken | GemTokenDenied | GemPlayer | GemPause | GemPrefs | GemCohorts | GemEarnAllowanceChanged | GemViewport | GemDeviceSettings | GemWillTerminate | GemRoomEvent | GemSocketState | GemSeatedEvent | GemAutoStartFailedEvent | GemTicketEvent | GemSignalEvent | GemDedicatedEvent | GemPartyResult | GemClusterTarget | GemDevtools | GemScreenshot | GemRequestContext | GemLocalServer | GemLocalServerDenied | GemMenuSelect | GemError | GemPurchaseResult | GemDeviceSettingsResult | GemAdResult | GemSignInResult | GemFriendChallengeResult;
|
|
547
|
-
type FrameMessage = GemHandshakeAccept | GemScreenshotDenied | GemGameContext | GemSignal | GemDedicatedOffer | GemPartyRequest | GemReady | GemEngaged | GemProgress | GemRequestToken | GemRequestLocalServer | GemExit | GemOpenExternal | GemRequestFullscreen | GemAudioState | GemRewardCue | GemWalletDisplay | GemControlsDeclare | GemMenu | GemRequestShare | GemRequestAvatarPicker | GemVibrate | GemFrameStats | GemPortraitBorders | GemError | GemRequestPurchase | GemDeviceSettingsPut | GemRequestAd | GemRequestSignIn | GemRequestFriendChallenge;
|
|
567
|
+
type FrameMessage = GemHandshakeAccept | GemScreenshotDenied | GemGameContext | GemSignal | GemDedicatedOffer | GemPartyRequest | GemReady | GemEngaged | GemProgress | GemRequestToken | GemRequestLocalServer | GemExit | GemOpenExternal | GemRequestFullscreen | GemAudioState | GemRewardCue | GemWalletDisplay | GemControlsDeclare | GemMenu | GemGemCorner | GemRequestShare | GemRequestAvatarPicker | GemVibrate | GemFrameStats | GemPortraitBorders | GemError | GemRequestPurchase | GemRequestAvatar3dPurchase | GemDeviceSettingsPut | GemRequestAd | GemRequestSignIn | GemRequestFriendChallenge;
|
|
548
568
|
type GemMessage = ParentMessage | FrameMessage;
|
|
549
569
|
type Rejection = string | null;
|
|
550
570
|
declare function isOrigin(s: string): boolean;
|
|
@@ -594,6 +614,7 @@ declare const validateGemWalletDisplay: (raw: unknown) => Rejection;
|
|
|
594
614
|
declare const validateGemControlsDeclare: (raw: unknown) => Rejection;
|
|
595
615
|
declare const validateGemMenu: (raw: unknown) => Rejection;
|
|
596
616
|
declare const validateGemMenuSelect: (raw: unknown) => Rejection;
|
|
617
|
+
declare const validateGemGemCorner: (raw: unknown) => Rejection;
|
|
597
618
|
declare const validateGemRequestShare: (raw: unknown) => Rejection;
|
|
598
619
|
declare const validateGemRequestAvatarPicker: (raw: unknown) => Rejection;
|
|
599
620
|
declare const validateGemVibrate: (raw: unknown) => Rejection;
|
|
@@ -601,6 +622,7 @@ declare const validateGemFrameStats: (raw: unknown) => Rejection;
|
|
|
601
622
|
declare const validateGemPortraitBorders: (raw: unknown) => Rejection;
|
|
602
623
|
declare const validateGemError: (raw: unknown) => Rejection;
|
|
603
624
|
declare const validateGemRequestPurchase: (raw: unknown) => Rejection;
|
|
625
|
+
declare const validateGemRequestAvatar3dPurchase: (raw: unknown) => Rejection;
|
|
604
626
|
declare const validateGemPurchaseResult: (raw: unknown) => Rejection;
|
|
605
627
|
declare const validateGemDeviceSettingsPut: (raw: unknown) => Rejection;
|
|
606
628
|
declare const validateGemDeviceSettingsResult: (raw: unknown) => Rejection;
|
|
@@ -611,14 +633,7 @@ declare const validateGemSignInResult: (raw: unknown) => Rejection;
|
|
|
611
633
|
declare const validateGemRequestFriendChallenge: (raw: unknown) => Rejection;
|
|
612
634
|
declare const validateGemFriendChallengeResult: (raw: unknown) => Rejection;
|
|
613
635
|
declare const VALIDATORS: Readonly<Record<string, (raw: unknown) => Rejection>>;
|
|
614
|
-
type
|
|
615
|
-
interface GemControlsDeclaration {
|
|
616
|
-
readonly lookSensitivity?: GemControlChoice;
|
|
617
|
-
readonly gamepadLookSensitivity?: GemControlChoice;
|
|
618
|
-
readonly invertLookY?: GemControlChoice;
|
|
619
|
-
readonly touchMovement?: GemControlChoice;
|
|
620
|
-
}
|
|
621
|
-
type PurchaseRefusalCode = "unknown_currency" | "currency_not_in_game_payable" | "not_purchasable" | "no_price_in_currency" | "busy" | "cancelled" | "insufficient_funds" | "price_mismatch" | "config_version_stale" | "platform_currency_unavailable" | "not_available" | "recipe_locked" | "recipe_on_cooldown" | "recipe_max_uses_exceeded" | "item_max_stack_exceeded" | "recipe_costs_unmet" | "quantity_invalid" | "error";
|
|
636
|
+
type PurchaseRefusalCode = "unknown_currency" | "currency_not_in_game_payable" | "not_purchasable" | "no_price_in_currency" | "busy" | "cancelled" | "insufficient_funds" | "price_mismatch" | "config_version_stale" | "platform_currency_unavailable" | "not_available" | "recipe_locked" | "already_owned" | "recipe_on_cooldown" | "recipe_max_uses_exceeded" | "item_max_stack_exceeded" | "recipe_costs_unmet" | "quantity_invalid" | "error";
|
|
622
637
|
interface OfferRefusal {
|
|
623
638
|
readonly reason: string;
|
|
624
639
|
}
|
|
@@ -745,6 +760,12 @@ interface SendPlayerInput {
|
|
|
745
760
|
readonly avatar3dId?: string;
|
|
746
761
|
readonly avatar3dModelUrl?: string;
|
|
747
762
|
readonly avatar3dIconUrl?: string;
|
|
763
|
+
readonly avatars3d?: readonly {
|
|
764
|
+
readonly family: string;
|
|
765
|
+
readonly id: string;
|
|
766
|
+
readonly modelUrl: string;
|
|
767
|
+
readonly iconUrl: string;
|
|
768
|
+
}[];
|
|
748
769
|
readonly badges?: readonly {
|
|
749
770
|
readonly itemId: string;
|
|
750
771
|
readonly iconUrl: string;
|
|
@@ -789,8 +810,8 @@ interface HostCallbacks {
|
|
|
789
810
|
onEngaged?(): void;
|
|
790
811
|
onRewardCue?(msg: GemRewardCue): void;
|
|
791
812
|
onWalletDisplay?(msg: GemWalletDisplay): void;
|
|
792
|
-
onControlsDeclare?(uses: GemControlsDeclaration): void;
|
|
793
813
|
onMenu?(msg: GemMenu): void;
|
|
814
|
+
onGemCorner?(msg: GemGemCorner): void;
|
|
794
815
|
onFrameStats?(msg: GemFrameStats): void;
|
|
795
816
|
onPortraitBorders?(name: string | null): void;
|
|
796
817
|
onScreenshotDenied?(msg: GemScreenshotDenied): void;
|
|
@@ -806,6 +827,7 @@ interface HostCallbacks {
|
|
|
806
827
|
onRequestAvatarPicker?(request: {
|
|
807
828
|
readonly tab?: "2d" | "3d";
|
|
808
829
|
}): void;
|
|
830
|
+
onRequestAvatar3dPurchase?(msg: GemRequestAvatar3dPurchase): void;
|
|
809
831
|
onVibrate?(msg: GemVibrate): void;
|
|
810
832
|
onPartyEvent?(event: PartyEventRelay): void;
|
|
811
833
|
onError?(code: GemErrorCode, message?: string): void;
|
|
@@ -1016,6 +1038,13 @@ interface PlayerBadge {
|
|
|
1016
1038
|
readonly itemId: string;
|
|
1017
1039
|
readonly iconUrl: string;
|
|
1018
1040
|
}
|
|
1041
|
+
type Avatar3dFamily = "small_human" | "adult_human" | (string & {});
|
|
1042
|
+
interface WornAvatar3d {
|
|
1043
|
+
readonly family: Avatar3dFamily;
|
|
1044
|
+
readonly id: string;
|
|
1045
|
+
readonly modelUrl: string;
|
|
1046
|
+
readonly iconUrl: string;
|
|
1047
|
+
}
|
|
1019
1048
|
interface PlayerIdentity {
|
|
1020
1049
|
readonly playerId?: string;
|
|
1021
1050
|
readonly displayName?: PlayerText;
|
|
@@ -1026,6 +1055,7 @@ interface PlayerIdentity {
|
|
|
1026
1055
|
readonly avatar3dId?: string;
|
|
1027
1056
|
readonly avatar3dModelUrl?: string;
|
|
1028
1057
|
readonly avatar3dIconUrl?: string;
|
|
1058
|
+
readonly avatars3d?: readonly WornAvatar3d[];
|
|
1029
1059
|
readonly badges: readonly PlayerBadge[];
|
|
1030
1060
|
}
|
|
1031
1061
|
interface RewardCue {
|
|
@@ -1036,6 +1066,7 @@ interface RewardCue {
|
|
|
1036
1066
|
y: number;
|
|
1037
1067
|
};
|
|
1038
1068
|
}
|
|
1069
|
+
type GemCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
|
|
1039
1070
|
type FrameState = "waiting" | "connected" | "refused" | "closed";
|
|
1040
1071
|
interface FramePlayer extends PlayerIdentity {
|
|
1041
1072
|
readonly displayName: PlayerText;
|
|
@@ -1126,11 +1157,11 @@ declare class GemFrame {
|
|
|
1126
1157
|
setWalletVisible(visible: boolean, options?: {
|
|
1127
1158
|
only?: readonly string[];
|
|
1128
1159
|
}): boolean;
|
|
1129
|
-
|
|
1130
|
-
setMenu(settings: boolean, items?: ReadonlyArray<{
|
|
1160
|
+
setMenu(items?: ReadonlyArray<{
|
|
1131
1161
|
readonly id: string;
|
|
1132
1162
|
readonly label: string;
|
|
1133
1163
|
}>): boolean;
|
|
1164
|
+
setGemCorner(corner: GemCorner): boolean;
|
|
1134
1165
|
requestShare(params: ReadonlyArray<{
|
|
1135
1166
|
readonly key: string;
|
|
1136
1167
|
readonly value: string;
|
|
@@ -1146,6 +1177,7 @@ declare class GemFrame {
|
|
|
1146
1177
|
dedicatedOffer(matchId: string, sdp: string, intent: GemDedicatedOffer["intent"]): void;
|
|
1147
1178
|
requestParty(requestId: string): boolean;
|
|
1148
1179
|
requestPurchase(requestId: string, purchaseKind: "item" | "recipe", targetId: string, currencySlug: string, quantity?: number, catalogId?: string): boolean;
|
|
1180
|
+
requestAvatar3dPurchase(requestId: string, itemId: string, currencySlug: string): boolean;
|
|
1149
1181
|
putDeviceSettings(requestId: string, settings: Readonly<Record<string, unknown>>): boolean;
|
|
1150
1182
|
requestAd(requestId: string, placement: string, format: "interstitial" | "rewarded"): boolean;
|
|
1151
1183
|
requestSignIn(requestId: string): boolean;
|
|
@@ -1156,6 +1188,7 @@ declare class GemFrame {
|
|
|
1156
1188
|
private dropUnknownType;
|
|
1157
1189
|
private refuse;
|
|
1158
1190
|
private fail;
|
|
1191
|
+
private gated;
|
|
1159
1192
|
private send;
|
|
1160
1193
|
private receive;
|
|
1161
1194
|
private dispatchInbound;
|
|
@@ -2401,4 +2434,4 @@ interface P2pMatchApi {
|
|
|
2401
2434
|
session(matchId: string): P2pSession | null;
|
|
2402
2435
|
}
|
|
2403
2436
|
declare function createP2pApi(options: P2pApiOptions): P2pMatchApi;
|
|
2404
|
-
export { type AutoReconnectOptions, type AwaitMatchOptions, CAPABILITY_GATES, CAPABILITY_NAMESPACE_GATES, CHANNELS, CHANNEL_KINDS, type ChannelKind, type ClientPlatform, ClientTelemetry, type ClientTelemetryOptions, type ClientVersion, type Clock, type ClusterTarget, type ClusterTargetBridge, type ClusterTargetLike, type ClusterTargetListResolver, type ClusterTargetRefresher, type ClusterTargetResolver, type ClusterTargetSource, type ClusterTargetSourceOptions, type ConnectOptions, type CreateRoomOptions, INBOUND_EVENTS as DEDICATED_INBOUND_EVENTS, DEFAULT_WELCOME_CEILING_MS, DEVICE_SETTINGS_MAX_BYTES, type DataChannelLike$1 as DataChannelLike, type DedicatedServerApi, type DedicatedServerApiOptions, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DedicatedSignalTransport, DedicatedSignalingHub, type DedicatedSignalingOptions, type EstablishOptions, FRAME_TO_PARENT, type FailedMatch, type FrameCallbacks, type FrameMessage, type FrameOptions, type FrameState, type GemAdResult, type GemAudioState, type GemAutoStartFailedEvent, type GemCapability, type GemClusterTarget, type GemCohorts, type
|
|
2437
|
+
export { type AutoReconnectOptions, type AwaitMatchOptions, CAPABILITY_GATES, CAPABILITY_NAMESPACE_GATES, CHANNELS, CHANNEL_KINDS, type ChannelKind, type ClientPlatform, ClientTelemetry, type ClientTelemetryOptions, type ClientVersion, type Clock, type ClusterTarget, type ClusterTargetBridge, type ClusterTargetLike, type ClusterTargetListResolver, type ClusterTargetRefresher, type ClusterTargetResolver, type ClusterTargetSource, type ClusterTargetSourceOptions, type ConnectOptions, type CreateRoomOptions, INBOUND_EVENTS as DEDICATED_INBOUND_EVENTS, DEFAULT_WELCOME_CEILING_MS, DEVICE_SETTINGS_MAX_BYTES, type DataChannelLike$1 as DataChannelLike, type DedicatedServerApi, type DedicatedServerApiOptions, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DedicatedSignalTransport, DedicatedSignalingHub, type DedicatedSignalingOptions, type EstablishOptions, FRAME_TO_PARENT, type FailedMatch, type FrameCallbacks, type FrameMessage, type FrameOptions, type FrameState, type GemAdResult, type GemAudioState, type GemAutoStartFailedEvent, type GemCapability, type GemClusterTarget, type GemCohorts, type GemControlsDeclare, type GemDedicatedEvent, type GemDedicatedOffer, type GemDeviceSettings, type GemDeviceSettingsPut, type GemDeviceSettingsResult, type GemDevtools, type GemEarnAllowanceChanged, type GemEngaged, type GemError, type GemErrorCode, type GemExit, GemFrame, type GemFrameStats, type GemFriendChallengeResult, type GemGameContext, type GemGemCorner, type GemHandshake, type GemHandshakeAccept, GemHost, type GemLocalServer, type GemLocalServerDenied, type GemMenu, type GemMenuSelect, type GemMessage, type GemOpenExternal, type GemPartyRequest, type GemPartyResult, type GemPause, type GemPlayer, type GemPortraitBorders, type GemPrefs, type GemProgress, type GemPurchaseResult, type GemReady, type GemRequestAd, type GemRequestAvatar3dPurchase, type GemRequestAvatarPicker, type GemRequestContext, type GemRequestFriendChallenge, type GemRequestFullscreen, type GemRequestLocalServer, type GemRequestPurchase, type GemRequestShare, type GemRequestSignIn, type GemRequestToken, type GemRewardCue, type GemRoomEvent, type GemScreenshot, type GemScreenshotDenied, type GemSeatedEvent, type GemSignInResult, type GemSignal, type GemSignalEvent, type GemSocketState, type GemTicketEvent, type GemToken, type GemTokenDenied, type GemVibrate, type GemViewport, type GemWalletDisplay, type GemWillTerminate, HANDSHAKE_TIMEOUT_MS, type HandshakeEvent, type HostCallbacks, HostMigration, type HostOptions, type HostState, type JoinCredential, type JoinExchange, type JoinRoomOptions, type JoinWelcome, type KeySource, type ListRoomsOptions, MALFORMED_INBOUND_KEY, MAX_ARRAY_LENGTH, MAX_CLUSTER_TARGETS, MAX_MESSAGE_BYTES, MAX_MESSAGE_DEPTH, MAX_MESSAGE_NODES, MAX_SIGNALS_PER_SECOND, MAX_SOCKET_FRAME_BYTES, MIGRATION_TIMEOUT_MS, type MatchAutoStartFailed, type MatchConnectionState, type MatchEnded, type MatchOutcome, type MatchOutcomeWaitOptions, type MatchReconnected, type MatchReconnecting, type MatchSession, type MatchSessionPhase, type MatchSuspended, type MatchTicket, type MatchTicketOutcome, type MatchTicketStatus, type MigrationState, type OfferRefusal, type OfferRequest, P2pApi, type P2pConnectOptions, P2pError, type P2pEventMap, type P2pEventName, type P2pFailure, type P2pMatchApi, type P2pPeer, P2pSession, PARENT_TO_FRAME, PROTOCOL, type ParentMessage, type PartyBridge, type PartyEventRelay, type PartyResolver, type PartyResolverOptions, type PartyTicket, type PartyTicketOutcome, type PartyTicketStatus, type PeerConnectionLike$1 as PeerConnectionLike, PlayerText, type PortLike, type PortMessageHandler, type PresentCredentialOptions, type PurchaseRefusalCode, type QueueForMatchOptions, type QuickJoinOptions, RATE_LIMITS, RateLimiter, type ReadyMatch, type Rejection, type RelayedDedicatedEvent, type RelayedRoomEvent, type RelayedSignal, type RelayedTicketEvent, type ResolvedClientVersion, type Room, type RoomArgEntry, type RoomArgScalar, type RoomArgType, type RoomArgValue, type RoomArgs, RoomEmitter, type RoomEventMap, type RoomEventName, type RoomManager, type RoomManagerOptions, type RoomMember, type RoomOperationError, type RoomPage, type RoomStatus, type RoomSummary, RoomsApi, type RoomsApiOptions, SUPPORTED_VERSIONS, type SdpType$1 as SdpType, type SendPlayerInput, type SessionDescriptionLike$1 as SessionDescriptionLike, type SignalTransport, type SignalingAnswer, type SignalingChannel, SignalingClient, type SignalingIntent, type StartMatchOptions, type StartedMatch$1 as StartedMatch, TELEMETRY_EVENTS, TRANSPORT_LABELS, type TelemetrySample, type TokenDenial, type TokenGrant, type TransportLabel, type TurnLease, type UpdateRoomOptions, VALIDATORS, type VerifiedCredential, WEBRTC_DEDICATED, WEBRTC_P2P, WEB_ENGINE_VERSION, WEB_PROTOCOL_VERSION, type WindowLike, asPlayerText, awaitMatchOutcome, browserPeerConnection, buildDedicatedOfferFrame, buildSocketFrame, capabilityFor, createClusterTargetSource, createDedicatedServerApi, createKeySource, createP2pApi, createPartyResolver, createRoomManager, deviceSettingsByteLength, establishDataChannel, fingerprintOf, fingerprintsMatch, generateCertificate, isOrigin, listClusterTargets, memberFromWire, negotiateVersion, normaliseClusterTarget, normaliseClusterTargets, normaliseFingerprint, originsEqual, presentJoinCredential, projectDedicatedEvent, projectPartyEvent, projectSignal, roomArgValuesFromWire, roomArgsTemplateFromWire, roomFromWire, startMatch, summaryFromWire, systemClock, text, unavailableSignaling, validateGemAdResult, validateGemAudioState, validateGemAutoStartFailedEvent, validateGemClusterTarget, validateGemCohorts, validateGemControlsDeclare, validateGemDedicatedEvent, validateGemDedicatedOffer, validateGemDeviceSettings, validateGemDeviceSettingsPut, validateGemDeviceSettingsResult, validateGemDevtools, validateGemEarnAllowanceChanged, validateGemEngaged, validateGemError, validateGemExit, validateGemFrameStats, validateGemFriendChallengeResult, validateGemGameContext, validateGemGemCorner, validateGemHandshake, validateGemHandshakeAccept, validateGemLocalServer, validateGemLocalServerDenied, validateGemMenu, validateGemMenuSelect, validateGemOpenExternal, validateGemPartyRequest, validateGemPartyResult, validateGemPause, validateGemPlayer, validateGemPortraitBorders, validateGemPrefs, validateGemProgress, validateGemPurchaseResult, validateGemReady, validateGemRequestAd, validateGemRequestAvatar3dPurchase, validateGemRequestAvatarPicker, validateGemRequestContext, validateGemRequestFriendChallenge, validateGemRequestFullscreen, validateGemRequestLocalServer, validateGemRequestPurchase, validateGemRequestShare, validateGemRequestSignIn, validateGemRequestToken, validateGemRewardCue, validateGemRoomEvent, validateGemScreenshot, validateGemScreenshotDenied, validateGemSeatedEvent, validateGemSignInResult, validateGemSignal, validateGemSignalEvent, validateGemSocketState, validateGemTicketEvent, validateGemToken, validateGemTokenDenied, validateGemVibrate, validateGemViewport, validateGemWalletDisplay, validateGemWillTerminate, validateSize, verifyCredential };
|
package/dist/sdk.d.ts
CHANGED
|
@@ -212,6 +212,7 @@ type GameConfigSnapshot = {
|
|
|
212
212
|
"analytics_events"?: SnapshotAnalyticsEvent[];
|
|
213
213
|
"analytics_funnels"?: SnapshotAnalyticsFunnel[];
|
|
214
214
|
"async_opponent_types"?: SnapshotAsyncOpponentType[];
|
|
215
|
+
"avatar_3d_families"?: string[];
|
|
215
216
|
"catalogs": SnapshotCatalog[];
|
|
216
217
|
"currencies": SnapshotCurrency[];
|
|
217
218
|
"friend_challenge_templates"?: SnapshotFriendChallengeTemplate[];
|
|
@@ -1176,6 +1177,13 @@ interface PlayerBadge$1 {
|
|
|
1176
1177
|
readonly itemId: string;
|
|
1177
1178
|
readonly iconUrl: string;
|
|
1178
1179
|
}
|
|
1180
|
+
type Avatar3dFamily = "small_human" | "adult_human" | (string & {});
|
|
1181
|
+
interface WornAvatar3d$1 {
|
|
1182
|
+
readonly family: Avatar3dFamily;
|
|
1183
|
+
readonly id: string;
|
|
1184
|
+
readonly modelUrl: string;
|
|
1185
|
+
readonly iconUrl: string;
|
|
1186
|
+
}
|
|
1179
1187
|
interface PlayerIdentity {
|
|
1180
1188
|
readonly playerId?: string;
|
|
1181
1189
|
readonly displayName?: PlayerText;
|
|
@@ -1186,6 +1194,7 @@ interface PlayerIdentity {
|
|
|
1186
1194
|
readonly avatar3dId?: string;
|
|
1187
1195
|
readonly avatar3dModelUrl?: string;
|
|
1188
1196
|
readonly avatar3dIconUrl?: string;
|
|
1197
|
+
readonly avatars3d?: readonly WornAvatar3d$1[];
|
|
1189
1198
|
readonly badges: readonly PlayerBadge$1[];
|
|
1190
1199
|
}
|
|
1191
1200
|
declare function mapIdentity(row: unknown): PlayerIdentity;
|
|
@@ -3375,6 +3384,7 @@ type PlayerIdentityFields = {
|
|
|
3375
3384
|
"avatar_3d_model_url"?: string | null;
|
|
3376
3385
|
"avatar_icon_id"?: string | null;
|
|
3377
3386
|
"avatar_icon_url"?: string | null;
|
|
3387
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
3378
3388
|
"badges"?: PlayerBadge[];
|
|
3379
3389
|
"discriminator"?: string | null;
|
|
3380
3390
|
"display_name"?: string | null;
|
|
@@ -3602,6 +3612,7 @@ type SubjectIdentityFields = {
|
|
|
3602
3612
|
"avatar_3d_model_url"?: string | null;
|
|
3603
3613
|
"avatar_icon_id"?: string | null;
|
|
3604
3614
|
"avatar_icon_url"?: string | null;
|
|
3615
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
3605
3616
|
"badges": PlayerBadge[];
|
|
3606
3617
|
"discriminator"?: string | null;
|
|
3607
3618
|
"display_name"?: string | null;
|
|
@@ -3763,6 +3774,12 @@ type WindowPreviewResponse = {
|
|
|
3763
3774
|
"ends_at": string;
|
|
3764
3775
|
"starts_at": string;
|
|
3765
3776
|
};
|
|
3777
|
+
type WornAvatar3d = {
|
|
3778
|
+
"avatar_3d_id": string;
|
|
3779
|
+
"family": string;
|
|
3780
|
+
"icon_url": string;
|
|
3781
|
+
"model_url": string;
|
|
3782
|
+
};
|
|
3766
3783
|
declare function acceptTransfer(api: GameApi, transfer_id: string, options?: {
|
|
3767
3784
|
signal?: AbortSignal;
|
|
3768
3785
|
}): Promise<TransferResponse>;
|
|
@@ -4143,6 +4160,7 @@ type generated_UpdateGameRoomRequest = UpdateGameRoomRequest;
|
|
|
4143
4160
|
type generated_UpdateRoomArgsRequest = UpdateRoomArgsRequest;
|
|
4144
4161
|
type generated_WindowKind = WindowKind;
|
|
4145
4162
|
type generated_WindowPreviewResponse = WindowPreviewResponse;
|
|
4163
|
+
type generated_WornAvatar3d = WornAvatar3d;
|
|
4146
4164
|
declare const generated_acceptTransfer: typeof acceptTransfer;
|
|
4147
4165
|
declare const generated_addEntityProgression: typeof addEntityProgression;
|
|
4148
4166
|
declare const generated_adminAction: typeof adminAction;
|
|
@@ -4205,7 +4223,7 @@ declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
|
|
|
4205
4223
|
declare const generated_transferHostV2: typeof transferHostV2;
|
|
4206
4224
|
declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
|
|
4207
4225
|
declare namespace generated {
|
|
4208
|
-
export { type generated_AchievementUnlockOutcome as AchievementUnlockOutcome, type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, type generated_AnalyticsBatchRequest as AnalyticsBatchRequest, type generated_AnalyticsBatchResponse as AnalyticsBatchResponse, type generated_AnalyticsEventSubmission as AnalyticsEventSubmission, type generated_AnalyticsRejection as AnalyticsRejection, type generated_BackfillPolicy as BackfillPolicy, type generated_BackfillSettings as BackfillSettings, type generated_BadgeKind as BadgeKind, type generated_BadgeLabel as BadgeLabel, type generated_BatchOrderItem as BatchOrderItem, type generated_BatchOrderItemResult as BatchOrderItemResult, type generated_BatchOrderRequest as BatchOrderRequest, type generated_BatchOrderResponse as BatchOrderResponse, type generated_BucketBalanceResponse as BucketBalanceResponse, type generated_CatalogItem as CatalogItem, type generated_CatalogPrice as CatalogPrice, type generated_CatalogRecipe as CatalogRecipe, type generated_ChallengeListResponse as ChallengeListResponse, type generated_ChallengePeriodResponse as ChallengePeriodResponse, type generated_ClientPlatform as ClientPlatform, type generated_ConfigAssignmentNotice as ConfigAssignmentNotice, type generated_ConfigChannelAssignmentResponse as ConfigChannelAssignmentResponse, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EarningResetActorKind as EarningResetActorKind, type generated_EarningResetGameFigure as EarningResetGameFigure, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemCategory as ItemCategory, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardPeriodFields as LeaderboardPeriodFields, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchBackfillRequest as MatchBackfillRequest, type generated_MatchBackfillResponse as MatchBackfillResponse, type MatchPlayerReport$1 as MatchPlayerReport, type generated_MatchPlayerReportOutcome as MatchPlayerReportOutcome, type MatchPlayerReportResult$1 as MatchPlayerReportResult, type generated_MatchPlayerState as MatchPlayerState, type generated_MatchPlayersReportRequest as MatchPlayersReportRequest, type generated_MatchPlayersReportResponse as MatchPlayersReportResponse, type generated_MatchType as MatchType, type generated_MatchmakingSettings as MatchmakingSettings, type generated_MatchmakingStrategy as MatchmakingStrategy, type generated_MilestoneMetric as MilestoneMetric, type generated_NameStyle as NameStyle, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PeriodProgressResponse as PeriodProgressResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, type generated_PlayerBadge as PlayerBadge, type generated_PlayerGameProfileResponse as PlayerGameProfileResponse, type generated_PlayerIdentityFields as PlayerIdentityFields, type generated_PlayerTitle as PlayerTitle, type generated_PrerequisiteType as PrerequisiteType, type generated_ProfileShowcaseEntry as ProfileShowcaseEntry, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, type generated_ProgressionMaxRequest as ProgressionMaxRequest, type generated_ProgressionResetRequest as ProgressionResetRequest, type generated_ProgressionStateOverride as ProgressionStateOverride, type generated_ProgressionStateResponse as ProgressionStateResponse, type generated_PurchaseCatalogResponse as PurchaseCatalogResponse, type generated_PutSettingRequest as PutSettingRequest, type generated_PutShowcaseRequest as PutShowcaseRequest, type generated_ReceiptPrincipal as ReceiptPrincipal, type generated_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, type generated_RecipeLockReason as RecipeLockReason, type generated_RecipePrerequisite as RecipePrerequisite, type generated_RecipeUsageListResponse as RecipeUsageListResponse, type generated_RecipeUsageResponse as RecipeUsageResponse, type generated_RoomArgType as RoomArgType, type generated_RoomArgsResponse as RoomArgsResponse, type generated_RoomArgsTemplate as RoomArgsTemplate, type generated_SaveDataResponse as SaveDataResponse, type generated_SaveFinalizeRequest as SaveFinalizeRequest, type generated_SaveUploadUrlRequest as SaveUploadUrlRequest, type generated_SaveUploadUrlResponse as SaveUploadUrlResponse, type generated_SettingResponse as SettingResponse, type generated_SettingsListResponse as SettingsListResponse, type generated_ShowcaseValueResponse as ShowcaseValueResponse, type generated_SimulateOrderRequest as SimulateOrderRequest, type generated_SimulateOrderResponse as SimulateOrderResponse, type generated_SimulationFailure as SimulationFailure, type generated_SimulationOutcome as SimulationOutcome, type generated_SimulationOverrides as SimulationOverrides, type generated_SlugOrId as SlugOrId, type generated_SubjectIdentityFields as SubjectIdentityFields, type generated_SuppliedBucketRow as SuppliedBucketRow, type generated_SuppliedCurrencies as SuppliedCurrencies, type generated_SuppliedCurrencyRow as SuppliedCurrencyRow, type generated_SuppliedInventory as SuppliedInventory, type generated_SuppliedItemRow as SuppliedItemRow, type generated_SuppliedItems as SuppliedItems, type generated_SuppliedPeriodProgressRow as SuppliedPeriodProgressRow, type generated_SuppliedProgressionRow as SuppliedProgressionRow, type generated_SuppliedProgressions as SuppliedProgressions, type generated_SuppliedScope as SuppliedScope, type generated_ThemedColors as ThemedColors, type generated_TransferCurrencyRequest as TransferCurrencyRequest, type generated_TransferItemRequest as TransferItemRequest, type generated_TransferResponse as TransferResponse, type generated_UnavailabilityReason as UnavailabilityReason, type generated_UpdateGameRoomRequest as UpdateGameRoomRequest, type generated_UpdateRoomArgsRequest as UpdateRoomArgsRequest, type generated_WindowKind as WindowKind, type generated_WindowPreviewResponse as WindowPreviewResponse, generated_acceptTransfer as acceptTransfer, generated_addEntityProgression as addEntityProgression, generated_adminAction as adminAction, generated_cancelInventoryTransfer as cancelInventoryTransfer, generated_claimEntityProgressionRewards as claimEntityProgressionRewards, generated_closeGameRoom as closeGameRoom, generated_createEntityBatchOrder as createEntityBatchOrder, generated_createEntityOrder as createEntityOrder, generated_createSession as createSession, generated_deleteEntityGameSetting as deleteEntityGameSetting, generated_deleteEntitySave as deleteEntitySave, generated_deleteSession as deleteSession, generated_deleteShowcaseValue as deleteShowcaseValue, generated_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, generated_getChannelAssignment as getChannelAssignment, generated_getDropRates as getDropRates, generated_getEntityCurrency as getEntityCurrency, generated_getEntityGameSetting as getEntityGameSetting, generated_getEntityInventory as getEntityInventory, generated_getEntityInventoryItem as getEntityInventoryItem, generated_getEntityLeaderboard as getEntityLeaderboard, generated_getEntityOrder as getEntityOrder, generated_getEntityProgression as getEntityProgression, generated_getEntityRecipeAvailability as getEntityRecipeAvailability, generated_getEntityRecipeUsage as getEntityRecipeUsage, generated_getEntitySave as getEntitySave, generated_getEvent as getEvent, generated_getGameRoomV2 as getGameRoomV2, generated_getLeaderboard as getLeaderboard, generated_getPlayerGameProfile as getPlayerGameProfile, generated_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getShowcaseValue as getShowcaseValue, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_invokeFunction as invokeFunction, generated_kickPlayer as kickPlayer, generated_listChallenges as listChallenges, generated_listEntityGameSettings as listEntityGameSettings, generated_listEntityOrders as listEntityOrders, generated_listEntityProgressions as listEntityProgressions, generated_listEntitySaves as listEntitySaves, generated_listEvents as listEvents, generated_listGameRooms as listGameRooms, generated_listResolvedTemplates as listResolvedTemplates, generated_listTransfers as listTransfers, generated_maxEntityProgression as maxEntityProgression, generated_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_putShowcaseValue as putShowcaseValue, generated_rejectTransfer as rejectTransfer, generated_reportMatchPlayers as reportMatchPlayers, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_setMatchBackfill as setMatchBackfill, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
|
|
4226
|
+
export { type generated_AchievementUnlockOutcome as AchievementUnlockOutcome, type generated_ActiveWindowResponse as ActiveWindowResponse, type generated_AdminActionRequest as AdminActionRequest, type generated_AnalyticsBatchRequest as AnalyticsBatchRequest, type generated_AnalyticsBatchResponse as AnalyticsBatchResponse, type generated_AnalyticsEventSubmission as AnalyticsEventSubmission, type generated_AnalyticsRejection as AnalyticsRejection, type generated_BackfillPolicy as BackfillPolicy, type generated_BackfillSettings as BackfillSettings, type generated_BadgeKind as BadgeKind, type generated_BadgeLabel as BadgeLabel, type generated_BatchOrderItem as BatchOrderItem, type generated_BatchOrderItemResult as BatchOrderItemResult, type generated_BatchOrderRequest as BatchOrderRequest, type generated_BatchOrderResponse as BatchOrderResponse, type generated_BucketBalanceResponse as BucketBalanceResponse, type generated_CatalogItem as CatalogItem, type generated_CatalogPrice as CatalogPrice, type generated_CatalogRecipe as CatalogRecipe, type generated_ChallengeListResponse as ChallengeListResponse, type generated_ChallengePeriodResponse as ChallengePeriodResponse, type generated_ClientPlatform as ClientPlatform, type generated_ConfigAssignmentNotice as ConfigAssignmentNotice, type generated_ConfigChannelAssignmentResponse as ConfigChannelAssignmentResponse, type generated_CreateOrderRequest as CreateOrderRequest, type generated_CreateSessionRequest as CreateSessionRequest, type generated_CurrencyBalanceResponse as CurrencyBalanceResponse, type generated_CurrencyResetOverride as CurrencyResetOverride, type generated_DropRateEntry as DropRateEntry, type generated_DropRatesResponse as DropRatesResponse, type generated_EarningResetActorKind as EarningResetActorKind, type generated_EarningResetGameFigure as EarningResetGameFigure, type generated_EntityLeaderboardEntryResponse as EntityLeaderboardEntryResponse, type generated_EntityLeaderboardResponse as EntityLeaderboardResponse, type generated_EntityType as EntityType, type generated_ErrorDetail as ErrorDetail, type generated_ErrorResponse as ErrorResponse, type generated_EventDefinitionResponse as EventDefinitionResponse, type generated_EventListResponse as EventListResponse, type generated_EventStatusInfo as EventStatusInfo, type generated_FidelityReport as FidelityReport, type generated_GameApi as GameApi, type generated_GameChannel as GameChannel, type generated_GameRoomMemberResponseV2 as GameRoomMemberResponseV2, type generated_GameRoomResponseV2 as GameRoomResponseV2, type generated_GameRoomSummaryResponse as GameRoomSummaryResponse, type generated_GameRoomTemplateListResponse as GameRoomTemplateListResponse, type generated_GameRoomTemplateResponse as GameRoomTemplateResponse, type generated_GameRoomsListResponse as GameRoomsListResponse, type generated_InitiateTransferRequest as InitiateTransferRequest, type generated_InventoryChange as InventoryChange, type generated_InventoryResponse as InventoryResponse, type generated_InventoryScopeResponse as InventoryScopeResponse, type generated_ItemCategory as ItemCategory, type generated_ItemInstanceResponse as ItemInstanceResponse, type generated_LeaderboardEntryResponse as LeaderboardEntryResponse, type generated_LeaderboardPeriodFields as LeaderboardPeriodFields, type generated_LeaderboardResponse as LeaderboardResponse, type generated_ListTransfersResponse as ListTransfersResponse, type generated_LootRollResultResponse as LootRollResultResponse, type generated_MatchBackfillRequest as MatchBackfillRequest, type generated_MatchBackfillResponse as MatchBackfillResponse, type MatchPlayerReport$1 as MatchPlayerReport, type generated_MatchPlayerReportOutcome as MatchPlayerReportOutcome, type MatchPlayerReportResult$1 as MatchPlayerReportResult, type generated_MatchPlayerState as MatchPlayerState, type generated_MatchPlayersReportRequest as MatchPlayersReportRequest, type generated_MatchPlayersReportResponse as MatchPlayersReportResponse, type generated_MatchType as MatchType, type generated_MatchmakingSettings as MatchmakingSettings, type generated_MatchmakingStrategy as MatchmakingStrategy, type generated_MilestoneMetric as MilestoneMetric, type generated_NameStyle as NameStyle, type generated_OperationRequest as OperationRequest, type generated_OrderListResponse as OrderListResponse, type generated_OrderRecordResponse as OrderRecordResponse, type generated_OrderResponse as OrderResponse, type generated_OrderSource as OrderSource, type generated_OrderStatus as OrderStatus, type generated_OverflowBehavior as OverflowBehavior, type generated_PaginatedCollectionCurrencyBalanceResponse as PaginatedCollectionCurrencyBalanceResponse, type generated_PaginatedCollectionItemInstanceResponse as PaginatedCollectionItemInstanceResponse, type generated_PaginatedCollectionProgressionStateResponse as PaginatedCollectionProgressionStateResponse, type generated_PaginatedResponseSaveDataResponse as PaginatedResponseSaveDataResponse, type generated_PeriodProgressResponse as PeriodProgressResponse, type generated_PlatformGrantClamp as PlatformGrantClamp, type generated_PlatformGrantOutcome as PlatformGrantOutcome, type generated_PlayerBadge as PlayerBadge, type generated_PlayerGameProfileResponse as PlayerGameProfileResponse, type generated_PlayerIdentityFields as PlayerIdentityFields, type generated_PlayerTitle as PlayerTitle, type generated_PrerequisiteType as PrerequisiteType, type generated_ProfileShowcaseEntry as ProfileShowcaseEntry, type generated_ProgressionAchievementState as ProgressionAchievementState, type generated_ProgressionAddRequest as ProgressionAddRequest, type generated_ProgressionClaimRequest as ProgressionClaimRequest, type generated_ProgressionMaxRequest as ProgressionMaxRequest, type generated_ProgressionResetRequest as ProgressionResetRequest, type generated_ProgressionStateOverride as ProgressionStateOverride, type generated_ProgressionStateResponse as ProgressionStateResponse, type generated_PurchaseCatalogResponse as PurchaseCatalogResponse, type generated_PutSettingRequest as PutSettingRequest, type generated_PutShowcaseRequest as PutShowcaseRequest, type generated_ReceiptPrincipal as ReceiptPrincipal, type generated_RecipeAvailabilityResponse as RecipeAvailabilityResponse, type generated_RecipeExecuteRequest as RecipeExecuteRequest, type generated_RecipeExecuteResponse as RecipeExecuteResponse, type generated_RecipeLockReason as RecipeLockReason, type generated_RecipePrerequisite as RecipePrerequisite, type generated_RecipeUsageListResponse as RecipeUsageListResponse, type generated_RecipeUsageResponse as RecipeUsageResponse, type generated_RoomArgType as RoomArgType, type generated_RoomArgsResponse as RoomArgsResponse, type generated_RoomArgsTemplate as RoomArgsTemplate, type generated_SaveDataResponse as SaveDataResponse, type generated_SaveFinalizeRequest as SaveFinalizeRequest, type generated_SaveUploadUrlRequest as SaveUploadUrlRequest, type generated_SaveUploadUrlResponse as SaveUploadUrlResponse, type generated_SettingResponse as SettingResponse, type generated_SettingsListResponse as SettingsListResponse, type generated_ShowcaseValueResponse as ShowcaseValueResponse, type generated_SimulateOrderRequest as SimulateOrderRequest, type generated_SimulateOrderResponse as SimulateOrderResponse, type generated_SimulationFailure as SimulationFailure, type generated_SimulationOutcome as SimulationOutcome, type generated_SimulationOverrides as SimulationOverrides, type generated_SlugOrId as SlugOrId, type generated_SubjectIdentityFields as SubjectIdentityFields, type generated_SuppliedBucketRow as SuppliedBucketRow, type generated_SuppliedCurrencies as SuppliedCurrencies, type generated_SuppliedCurrencyRow as SuppliedCurrencyRow, type generated_SuppliedInventory as SuppliedInventory, type generated_SuppliedItemRow as SuppliedItemRow, type generated_SuppliedItems as SuppliedItems, type generated_SuppliedPeriodProgressRow as SuppliedPeriodProgressRow, type generated_SuppliedProgressionRow as SuppliedProgressionRow, type generated_SuppliedProgressions as SuppliedProgressions, type generated_SuppliedScope as SuppliedScope, type generated_ThemedColors as ThemedColors, type generated_TransferCurrencyRequest as TransferCurrencyRequest, type generated_TransferItemRequest as TransferItemRequest, type generated_TransferResponse as TransferResponse, type generated_UnavailabilityReason as UnavailabilityReason, type generated_UpdateGameRoomRequest as UpdateGameRoomRequest, type generated_UpdateRoomArgsRequest as UpdateRoomArgsRequest, type generated_WindowKind as WindowKind, type generated_WindowPreviewResponse as WindowPreviewResponse, type generated_WornAvatar3d as WornAvatar3d, generated_acceptTransfer as acceptTransfer, generated_addEntityProgression as addEntityProgression, generated_adminAction as adminAction, generated_cancelInventoryTransfer as cancelInventoryTransfer, generated_claimEntityProgressionRewards as claimEntityProgressionRewards, generated_closeGameRoom as closeGameRoom, generated_createEntityBatchOrder as createEntityBatchOrder, generated_createEntityOrder as createEntityOrder, generated_createSession as createSession, generated_deleteEntityGameSetting as deleteEntityGameSetting, generated_deleteEntitySave as deleteEntitySave, generated_deleteSession as deleteSession, generated_deleteShowcaseValue as deleteShowcaseValue, generated_executeEntityRecipe as executeEntityRecipe, generated_finalizeSaveUpload as finalizeSaveUpload, generated_getChannelAssignment as getChannelAssignment, generated_getDropRates as getDropRates, generated_getEntityCurrency as getEntityCurrency, generated_getEntityGameSetting as getEntityGameSetting, generated_getEntityInventory as getEntityInventory, generated_getEntityInventoryItem as getEntityInventoryItem, generated_getEntityLeaderboard as getEntityLeaderboard, generated_getEntityOrder as getEntityOrder, generated_getEntityProgression as getEntityProgression, generated_getEntityRecipeAvailability as getEntityRecipeAvailability, generated_getEntityRecipeUsage as getEntityRecipeUsage, generated_getEntitySave as getEntitySave, generated_getEvent as getEvent, generated_getGameRoomV2 as getGameRoomV2, generated_getLeaderboard as getLeaderboard, generated_getPlayerGameProfile as getPlayerGameProfile, generated_getPurchaseCatalog as getPurchaseCatalog, generated_getResolvedTemplate as getResolvedTemplate, generated_getRoomArgs as getRoomArgs, generated_getShowcaseValue as getShowcaseValue, generated_getTransferDetails as getTransferDetails, generated_ingestAnalyticsEvents as ingestAnalyticsEvents, generated_initiateInventoryTransfer as initiateInventoryTransfer, generated_invokeFunction as invokeFunction, generated_kickPlayer as kickPlayer, generated_listChallenges as listChallenges, generated_listEntityGameSettings as listEntityGameSettings, generated_listEntityOrders as listEntityOrders, generated_listEntityProgressions as listEntityProgressions, generated_listEntitySaves as listEntitySaves, generated_listEvents as listEvents, generated_listGameRooms as listGameRooms, generated_listResolvedTemplates as listResolvedTemplates, generated_listTransfers as listTransfers, generated_maxEntityProgression as maxEntityProgression, generated_putEntityGameSetting as putEntityGameSetting, generated_putRoomArgs as putRoomArgs, generated_putShowcaseValue as putShowcaseValue, generated_rejectTransfer as rejectTransfer, generated_reportMatchPlayers as reportMatchPlayers, generated_requestSaveUploadUrl as requestSaveUploadUrl, generated_resetEntityProgression as resetEntityProgression, generated_setMatchBackfill as setMatchBackfill, generated_simulateEntityOrder as simulateEntityOrder, generated_transferHostV2 as transferHostV2, generated_updateGameRoomV2 as updateGameRoomV2 };
|
|
4209
4227
|
}
|
|
4210
4228
|
interface ServerAnalytics {
|
|
4211
4229
|
track(playerId: string, name: string, props?: Readonly<Record<string, AnalyticsValue>>): void;
|
|
@@ -4369,7 +4387,7 @@ interface GemMatchApi {
|
|
|
4369
4387
|
serve(server: GemMatchServerModule, options?: MatchServeOptions): Promise<MatchHosting>;
|
|
4370
4388
|
connect(options?: MatchConnectOptions): Promise<MatchConnection>;
|
|
4371
4389
|
}
|
|
4372
|
-
type PurchaseRefusalCode = "unknown_currency" | "currency_not_in_game_payable" | "not_purchasable" | "no_price_in_currency" | "busy" | "cancelled" | "insufficient_funds" | "price_mismatch" | "config_version_stale" | "platform_currency_unavailable" | "not_available" | "recipe_locked" | "recipe_on_cooldown" | "recipe_max_uses_exceeded" | "item_max_stack_exceeded" | "recipe_costs_unmet" | "quantity_invalid" | "error";
|
|
4390
|
+
type PurchaseRefusalCode = "unknown_currency" | "currency_not_in_game_payable" | "not_purchasable" | "no_price_in_currency" | "busy" | "cancelled" | "insufficient_funds" | "price_mismatch" | "config_version_stale" | "platform_currency_unavailable" | "not_available" | "recipe_locked" | "already_owned" | "recipe_on_cooldown" | "recipe_max_uses_exceeded" | "item_max_stack_exceeded" | "recipe_costs_unmet" | "quantity_invalid" | "error";
|
|
4373
4391
|
declare class PurchaseRefusal extends RangeError {
|
|
4374
4392
|
readonly code: Extract<PurchaseRefusalCode, "unknown_currency" | "not_purchasable" | "no_price_in_currency" | "quantity_invalid">;
|
|
4375
4393
|
readonly retryable: false;
|
|
@@ -4392,6 +4410,31 @@ type PurchaseOutcome = {
|
|
|
4392
4410
|
interface PurchaseApi {
|
|
4393
4411
|
request(req: PurchaseRequest): Promise<PurchaseOutcome>;
|
|
4394
4412
|
}
|
|
4413
|
+
interface Avatar3dPurchaseRequest {
|
|
4414
|
+
itemId: string;
|
|
4415
|
+
currencySlug: string;
|
|
4416
|
+
}
|
|
4417
|
+
interface Avatar3dPrice {
|
|
4418
|
+
readonly currencySlug: string;
|
|
4419
|
+
readonly price: number;
|
|
4420
|
+
}
|
|
4421
|
+
interface Avatar3dOffer {
|
|
4422
|
+
readonly itemId: string;
|
|
4423
|
+
readonly slug: string;
|
|
4424
|
+
readonly family: Avatar3dFamily;
|
|
4425
|
+
readonly displayName: string;
|
|
4426
|
+
readonly description?: string;
|
|
4427
|
+
readonly iconUrl: string;
|
|
4428
|
+
readonly modelUrl: string;
|
|
4429
|
+
readonly prices: readonly Avatar3dPrice[];
|
|
4430
|
+
}
|
|
4431
|
+
interface Avatars3dApi {
|
|
4432
|
+
families(): Promise<readonly Avatar3dFamily[]>;
|
|
4433
|
+
worn(family?: Avatar3dFamily): WornAvatar3d$1 | undefined;
|
|
4434
|
+
offers(): Promise<readonly Avatar3dOffer[]>;
|
|
4435
|
+
purchase(request: Avatar3dPurchaseRequest): Promise<PurchaseOutcome>;
|
|
4436
|
+
onChange(listener: (worn: readonly WornAvatar3d$1[]) => void): () => void;
|
|
4437
|
+
}
|
|
4395
4438
|
type SignInOutcomeKind = "signed_in" | "declined" | "unavailable";
|
|
4396
4439
|
interface SignInOutcome {
|
|
4397
4440
|
readonly outcome: SignInOutcomeKind;
|
|
@@ -4409,13 +4452,6 @@ interface PlayerBoost {
|
|
|
4409
4452
|
readonly multipliers: readonly PlayerBoostMultiplier[];
|
|
4410
4453
|
readonly expiresInDays?: number;
|
|
4411
4454
|
}
|
|
4412
|
-
type GemControlChoice = "player" | "game";
|
|
4413
|
-
interface GemControlsDeclaration {
|
|
4414
|
-
readonly lookSensitivity?: GemControlChoice;
|
|
4415
|
-
readonly gamepadLookSensitivity?: GemControlChoice;
|
|
4416
|
-
readonly invertLookY?: GemControlChoice;
|
|
4417
|
-
readonly touchMovement?: GemControlChoice;
|
|
4418
|
-
}
|
|
4419
4455
|
interface RewardCue {
|
|
4420
4456
|
currencySlug: string;
|
|
4421
4457
|
expected?: number;
|
|
@@ -4424,6 +4460,7 @@ interface RewardCue {
|
|
|
4424
4460
|
y: number;
|
|
4425
4461
|
};
|
|
4426
4462
|
}
|
|
4463
|
+
type GemCorner = "top-left" | "top-right" | "bottom-left" | "bottom-right";
|
|
4427
4464
|
type FrameState = "waiting" | "connected" | "refused" | "closed";
|
|
4428
4465
|
interface FramePlayer extends PlayerIdentity {
|
|
4429
4466
|
readonly displayName: PlayerText;
|
|
@@ -4514,11 +4551,11 @@ declare class GemFrame {
|
|
|
4514
4551
|
setWalletVisible(visible: boolean, options?: {
|
|
4515
4552
|
only?: readonly string[];
|
|
4516
4553
|
}): boolean;
|
|
4517
|
-
|
|
4518
|
-
setMenu(settings: boolean, items?: ReadonlyArray<{
|
|
4554
|
+
setMenu(items?: ReadonlyArray<{
|
|
4519
4555
|
readonly id: string;
|
|
4520
4556
|
readonly label: string;
|
|
4521
4557
|
}>): boolean;
|
|
4558
|
+
setGemCorner(corner: GemCorner): boolean;
|
|
4522
4559
|
requestShare(params: ReadonlyArray<{
|
|
4523
4560
|
readonly key: string;
|
|
4524
4561
|
readonly value: string;
|
|
@@ -4534,6 +4571,7 @@ declare class GemFrame {
|
|
|
4534
4571
|
dedicatedOffer(matchId: string, sdp: string, intent: GemDedicatedOffer["intent"]): void;
|
|
4535
4572
|
requestParty(requestId: string): boolean;
|
|
4536
4573
|
requestPurchase(requestId: string, purchaseKind: "item" | "recipe", targetId: string, currencySlug: string, quantity?: number, catalogId?: string): boolean;
|
|
4574
|
+
requestAvatar3dPurchase(requestId: string, itemId: string, currencySlug: string): boolean;
|
|
4537
4575
|
putDeviceSettings(requestId: string, settings: Readonly<Record<string, unknown>>): boolean;
|
|
4538
4576
|
requestAd(requestId: string, placement: string, format: "interstitial" | "rewarded"): boolean;
|
|
4539
4577
|
requestSignIn(requestId: string): boolean;
|
|
@@ -4544,6 +4582,7 @@ declare class GemFrame {
|
|
|
4544
4582
|
private dropUnknownType;
|
|
4545
4583
|
private refuse;
|
|
4546
4584
|
private fail;
|
|
4585
|
+
private gated;
|
|
4547
4586
|
private send;
|
|
4548
4587
|
private receive;
|
|
4549
4588
|
private dispatchInbound;
|
|
@@ -4587,7 +4626,6 @@ interface GemLook {
|
|
|
4587
4626
|
set(options: GemLookOptions): void;
|
|
4588
4627
|
}
|
|
4589
4628
|
interface ControlsApi {
|
|
4590
|
-
declare(uses: GemControlsDeclaration): boolean;
|
|
4591
4629
|
look(options?: GemLookOptions): GemLook;
|
|
4592
4630
|
readonly LOOK_BASE: GemLookBase;
|
|
4593
4631
|
}
|
|
@@ -4623,6 +4661,15 @@ interface DeviceSettingsApi {
|
|
|
4623
4661
|
declare class GemUnframedError extends Error {
|
|
4624
4662
|
constructor();
|
|
4625
4663
|
}
|
|
4664
|
+
interface AvatarRigNode {
|
|
4665
|
+
readonly node: string;
|
|
4666
|
+
readonly parent: string | null;
|
|
4667
|
+
}
|
|
4668
|
+
interface AvatarRigs {
|
|
4669
|
+
readonly small_human: readonly AvatarRigNode[];
|
|
4670
|
+
readonly adult_human: readonly AvatarRigNode[];
|
|
4671
|
+
}
|
|
4672
|
+
declare const AVATAR_RIGS: AvatarRigs;
|
|
4626
4673
|
declare const DEVICE_SETTINGS_MAX_BYTES = 16384;
|
|
4627
4674
|
declare const ARCADE_EMBEDDERS: readonly string[];
|
|
4628
4675
|
interface GemOptions {
|
|
@@ -4715,7 +4762,6 @@ interface GameMenuItem {
|
|
|
4715
4762
|
readonly onSelect: () => void;
|
|
4716
4763
|
}
|
|
4717
4764
|
interface GameMenu {
|
|
4718
|
-
readonly onSettings?: () => void;
|
|
4719
4765
|
readonly items?: readonly GameMenuItem[];
|
|
4720
4766
|
}
|
|
4721
4767
|
interface GemTerminationNotice {
|
|
@@ -4746,6 +4792,7 @@ interface Gem {
|
|
|
4746
4792
|
openAvatarPicker(options?: {
|
|
4747
4793
|
readonly tab?: "2d" | "3d";
|
|
4748
4794
|
}): boolean;
|
|
4795
|
+
readonly avatars3d: Avatars3dApi;
|
|
4749
4796
|
readonly vibration: VibrationApi;
|
|
4750
4797
|
readonly controls: ControlsApi;
|
|
4751
4798
|
readonly analytics: AnalyticsApi;
|
|
@@ -4767,6 +4814,7 @@ interface Gem {
|
|
|
4767
4814
|
cueReward(cue: RewardCue): boolean;
|
|
4768
4815
|
setWalletVisible(visible: boolean, options?: WalletVisibleOptions): boolean;
|
|
4769
4816
|
setMenu(menu: GameMenu): boolean;
|
|
4817
|
+
setGemCorner(corner: GemCorner): boolean;
|
|
4770
4818
|
exit(reason?: string): Promise<void>;
|
|
4771
4819
|
readonly boot: BootTimeline;
|
|
4772
4820
|
readonly frame: GemFrame;
|
|
@@ -4792,4 +4840,4 @@ interface ExitAnalytics {
|
|
|
4792
4840
|
}
|
|
4793
4841
|
declare function leaveAndExit(rooms: ExitRooms, bridge: ExitBridge | null, reason?: string, analytics?: ExitAnalytics): Promise<void>;
|
|
4794
4842
|
declare function createGem(options?: GemOptions): Gem;
|
|
4795
|
-
export { ARCADE_EMBEDDERS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, type ControlsApi, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EarnAllowance, type EarnAllowanceEvent, type EarnAllowancePeriod, type EarnAllowanceReadOptions, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, type FriendChallenge, FriendChallengeError, type FriendChallengeErrorCode, type FriendChallengeOutcome, type FriendChallengeOutcomeKind, type FriendChallengeRequest, type FriendChallengesPage, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameMenu, type GameMenuItem, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type
|
|
4843
|
+
export { ARCADE_EMBEDDERS, AVATAR_RIGS, type AccountApi, type AdFormat, type AdOutcome, type AdOutcomeKind, type AdRequest, type AdsApi, AnalyticsApi, type AnalyticsFlushOptions, type AnalyticsFlushResult, type AnalyticsOptions, type AnalyticsRejection$1 as AnalyticsRejection, type AnalyticsValue, AuthError, type AuthFailure, type AuthState, type Avatar3dFamily, type Avatar3dOffer, type Avatar3dPrice, type Avatar3dPurchaseRequest, type AvatarRigNode, type AvatarRigs, type Avatars3dApi, type Base64String, type BootMark, type BootTimeline, type BroadcastOptions, type BytesResponse, CONDITIONAL_HEADERS, type Challenge, type ChallengeWindow, ChallengesApi, type ClientOptions, type Clock, type ConditionalRequestHeaders, type ConfiguredPurchasePayment, type ConfiguredPurchaseRequest, type ConfiguredPurchaseResult, type ControlsApi, DEVICE_SETTINGS_MAX_BYTES, DedicatedServerError, type DedicatedServerFailure, type DedicatedServerSession, type DevToolsOpener, type DeviceSettings, type DeviceSettingsApi, type DeviceSettingsPutOutcome, type DirectPurchaseRequest, type DirectPurchaseResult, type EarnAllowance, type EarnAllowanceEvent, type EarnAllowancePeriod, type EarnAllowanceReadOptions, type EntityLeaderboard, type EntityLeaderboardEntry, type EntityLeaderboardOptions, type EntityType$1 as EntityType, type ExitAnalytics, type ExitBridge, type ExitRooms, type FrameState, type Friend, type FriendChallenge, FriendChallengeError, type FriendChallengeErrorCode, type FriendChallengeOutcome, type FriendChallengeOutcomeKind, type FriendChallengeRequest, type FriendChallengesPage, FriendsApi, type FriendsPage, type FunctionFailure, type FunctionInvokeOptions, type FunctionResult, FunctionsApi, type GameApi, type GameConfig, type GameMenu, type GameMenuItem, type GameServerLink, type Gem, GemApiError, GemClient, type GemCohort, type GemCohorts, GemConfigError, type GemCorner, type GemDevTools, type GemErrorReason, GemFrame, GemFunctionError, type GemGraphicsQuality, type GemIdentity, type GemInsets, type GemLook, type GemLookBase, type GemLookDelta, type GemLookOptions, type GemLookSpeed, type GemMatchApi, type GemMatchServer, type GemMatchServerModule, type GemOptions, type GemPlayer, type GemPrefs, type GemRecommendedSettings, type GemReservedArea, GemSaveError, type GemServer, type GemServerBundle, type GemServerFactory, type GemServerHost, type GemServerHostProfile, type GemServerIdentity, type GemServerLifecycle, type GemServerOptions, type GemServerProfile, type GemTerminationNotice, GemUnframedError, type GemViewport, type GetLeaderboardOptions, type HostTokenSource, type HostTokenSourceOptions, type JoinWelcome, type Leaderboard, type LeaderboardEntry, type LeaderboardPeriod, LeaderboardsApi, type ListChallengesOptions, type ListFriendChallengesOptions, type ListFriendsOptions, MAX_PERIODS_BACK, type MatchBackfillState, type MatchConnectOptions, type MatchConnection, type MatchHosting, type MatchHostingMode, type MatchPlayerReport, type MatchPlayerReportResult, type MatchServeOptions, type MatchTransport, type MessageMeta, type MultiTransportSession, PLATFORM_EVENTS, type PeriodOptions, PlatformApi, PlatformCurrenciesApi, type PlatformCurrency, type PlatformCurrencyAccess, type PlatformCurrencyPurchasePayment, type PlatformCurrencyPurchaseRequest, type PlatformCurrencyPurchaseResult, type PlatformCurrencyReadOptions, PlatformEarnAllowanceApi, type PlatformEventName, type PlayerBadge$1 as PlayerBadge, type PlayerBoost, type PlayerBoostMultiplier, type PlayerIdentity, type PlayerProfile, PlayerText, type ProfileCallOptions, type ProfileShowcaseEntry$1 as ProfileShowcaseEntry, ProfilesApi, type PurchaseApi, type PurchaseOptions, type PurchaseOutcome, PurchaseRefusal, type PurchaseRefusalCode, type PurchaseRequest, type PutBytesOptions, type PutSaveOptions, type RankedRow, type RecipeAvailability, type RecipeLock, type RequestOptions, type RewardCue, type RewardedStatus, type RoomArgValue, type SavePage, type SaveRecord, type SendOptions$1 as SendOptions, type ServerApi, type ServerBundleHost, type ServerTokenGrant, type SessionEndReason, type ShareApi, type ShareRequest, ShowcaseApi, type ShowcaseCallOptions, type ShowcaseFriendEntry, type ShowcaseFriends, type ShowcaseValue, type SignInOutcome, type SignInOutcomeKind, type SnapshotCurrency, type SnapshotItem, type TokenGrant, type Transport, type TransportAdvert, type TransportKind, TransportRefusal, type TransportRequest, type TransportResponse, UNRELIABLE_CHANNEL_LABEL, type VersionedGetOptions, type VersionedResponse, type VibrationApi, type WalletVisibleOptions, type WornAvatar3d$1 as WornAvatar3d, asPlayerText, createBootTimeline, createGem, createGemServer, createHostTokenSource, createMatchServer, defineServer, leaveAndExit, mapIdentity, markOnResolve, platformIconUrl, presentJoinCredential, readTemplateTransports, readTransportAdvert, reportOnResolve, systemClock, text, toBase64, webTransportAvailable };
|
package/dist/server-api.d.ts
CHANGED
|
@@ -782,6 +782,7 @@ type PlayerIdentityFields = {
|
|
|
782
782
|
"avatar_3d_model_url"?: string | null;
|
|
783
783
|
"avatar_icon_id"?: string | null;
|
|
784
784
|
"avatar_icon_url"?: string | null;
|
|
785
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
785
786
|
"badges"?: PlayerBadge[];
|
|
786
787
|
"discriminator"?: string | null;
|
|
787
788
|
"display_name"?: string | null;
|
|
@@ -1009,6 +1010,7 @@ type SubjectIdentityFields = {
|
|
|
1009
1010
|
"avatar_3d_model_url"?: string | null;
|
|
1010
1011
|
"avatar_icon_id"?: string | null;
|
|
1011
1012
|
"avatar_icon_url"?: string | null;
|
|
1013
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
1012
1014
|
"badges": PlayerBadge[];
|
|
1013
1015
|
"discriminator"?: string | null;
|
|
1014
1016
|
"display_name"?: string | null;
|
|
@@ -1170,6 +1172,12 @@ type WindowPreviewResponse = {
|
|
|
1170
1172
|
"ends_at": string;
|
|
1171
1173
|
"starts_at": string;
|
|
1172
1174
|
};
|
|
1175
|
+
type WornAvatar3d = {
|
|
1176
|
+
"avatar_3d_id": string;
|
|
1177
|
+
"family": string;
|
|
1178
|
+
"icon_url": string;
|
|
1179
|
+
"model_url": string;
|
|
1180
|
+
};
|
|
1173
1181
|
declare function acceptTransfer(api: GameApi, transfer_id: string, options?: {
|
|
1174
1182
|
signal?: AbortSignal;
|
|
1175
1183
|
}): Promise<TransferResponse>;
|
|
@@ -1405,4 +1413,4 @@ declare function updateGameRoomV2(api: GameApi, game_room_id: string, body: Upda
|
|
|
1405
1413
|
ifMatch?: string;
|
|
1406
1414
|
signal?: AbortSignal;
|
|
1407
1415
|
}): Promise<GameRoomResponseV2>;
|
|
1408
|
-
export { type AchievementUnlockOutcome, type ActiveWindowResponse, type AdminActionRequest, type AnalyticsBatchRequest, type AnalyticsBatchResponse, type AnalyticsEventSubmission, type AnalyticsRejection, type BackfillPolicy, type BackfillSettings, type BadgeKind, type BadgeLabel, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogPrice, type CatalogRecipe, type ChallengeListResponse, type ChallengePeriodResponse, type ClientPlatform, type ConfigAssignmentNotice, type ConfigChannelAssignmentResponse, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EarningResetActorKind, type EarningResetGameFigure, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemCategory, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardPeriodFields, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchBackfillRequest, type MatchBackfillResponse, type MatchPlayerReport, type MatchPlayerReportOutcome, type MatchPlayerReportResult, type MatchPlayerState, type MatchPlayersReportRequest, type MatchPlayersReportResponse, type MatchType, type MatchmakingSettings, type MatchmakingStrategy, type MilestoneMetric, type NameStyle, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PeriodProgressResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type PlayerBadge, type PlayerGameProfileResponse, type PlayerIdentityFields, type PlayerTitle, type PrerequisiteType, type ProfileShowcaseEntry, type ProgressionAchievementState, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionMaxRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PutSettingRequest, type PutShowcaseRequest, type ReceiptPrincipal, type RecipeAvailabilityResponse, type RecipeExecuteRequest, type RecipeExecuteResponse, type RecipeLockReason, type RecipePrerequisite, type RecipeUsageListResponse, type RecipeUsageResponse, type RoomArgType, type RoomArgsResponse, type RoomArgsTemplate, type SaveDataResponse, type SaveFinalizeRequest, type SaveUploadUrlRequest, type SaveUploadUrlResponse, type SettingResponse, type SettingsListResponse, type ShowcaseValueResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SubjectIdentityFields, type SuppliedBucketRow, type SuppliedCurrencies, type SuppliedCurrencyRow, type SuppliedInventory, type SuppliedItemRow, type SuppliedItems, type SuppliedPeriodProgressRow, type SuppliedProgressionRow, type SuppliedProgressions, type SuppliedScope, type ThemedColors, type TransferCurrencyRequest, type TransferItemRequest, type TransferResponse, type UnavailabilityReason, type UpdateGameRoomRequest, type UpdateRoomArgsRequest, type WindowKind, type WindowPreviewResponse, acceptTransfer, addEntityProgression, adminAction, cancelInventoryTransfer, claimEntityProgressionRewards, closeGameRoom, createEntityBatchOrder, createEntityOrder, createSession, deleteEntityGameSetting, deleteEntitySave, deleteSession, deleteShowcaseValue, executeEntityRecipe, finalizeSaveUpload, getChannelAssignment, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPlayerGameProfile, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getShowcaseValue, getTransferDetails, ingestAnalyticsEvents, initiateInventoryTransfer, invokeFunction, kickPlayer, listChallenges, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, maxEntityProgression, putEntityGameSetting, putRoomArgs, putShowcaseValue, rejectTransfer, reportMatchPlayers, requestSaveUploadUrl, resetEntityProgression, setMatchBackfill, simulateEntityOrder, transferHostV2, updateGameRoomV2 };
|
|
1416
|
+
export { type AchievementUnlockOutcome, type ActiveWindowResponse, type AdminActionRequest, type AnalyticsBatchRequest, type AnalyticsBatchResponse, type AnalyticsEventSubmission, type AnalyticsRejection, type BackfillPolicy, type BackfillSettings, type BadgeKind, type BadgeLabel, type BatchOrderItem, type BatchOrderItemResult, type BatchOrderRequest, type BatchOrderResponse, type BucketBalanceResponse, type CatalogItem, type CatalogPrice, type CatalogRecipe, type ChallengeListResponse, type ChallengePeriodResponse, type ClientPlatform, type ConfigAssignmentNotice, type ConfigChannelAssignmentResponse, type CreateOrderRequest, type CreateSessionRequest, type CurrencyBalanceResponse, type CurrencyResetOverride, type DropRateEntry, type DropRatesResponse, type EarningResetActorKind, type EarningResetGameFigure, type EntityLeaderboardEntryResponse, type EntityLeaderboardResponse, type EntityType, type ErrorDetail, type ErrorResponse, type EventDefinitionResponse, type EventListResponse, type EventStatusInfo, type FidelityReport, type GameApi, type GameChannel, type GameRoomMemberResponseV2, type GameRoomResponseV2, type GameRoomSummaryResponse, type GameRoomTemplateListResponse, type GameRoomTemplateResponse, type GameRoomsListResponse, type InitiateTransferRequest, type InventoryChange, type InventoryResponse, type InventoryScopeResponse, type ItemCategory, type ItemInstanceResponse, type LeaderboardEntryResponse, type LeaderboardPeriodFields, type LeaderboardResponse, type ListTransfersResponse, type LootRollResultResponse, type MatchBackfillRequest, type MatchBackfillResponse, type MatchPlayerReport, type MatchPlayerReportOutcome, type MatchPlayerReportResult, type MatchPlayerState, type MatchPlayersReportRequest, type MatchPlayersReportResponse, type MatchType, type MatchmakingSettings, type MatchmakingStrategy, type MilestoneMetric, type NameStyle, type OperationRequest, type OrderListResponse, type OrderRecordResponse, type OrderResponse, type OrderSource, type OrderStatus, type OverflowBehavior, type PaginatedCollectionCurrencyBalanceResponse, type PaginatedCollectionItemInstanceResponse, type PaginatedCollectionProgressionStateResponse, type PaginatedResponseSaveDataResponse, type PeriodProgressResponse, type PlatformGrantClamp, type PlatformGrantOutcome, type PlayerBadge, type PlayerGameProfileResponse, type PlayerIdentityFields, type PlayerTitle, type PrerequisiteType, type ProfileShowcaseEntry, type ProgressionAchievementState, type ProgressionAddRequest, type ProgressionClaimRequest, type ProgressionMaxRequest, type ProgressionResetRequest, type ProgressionStateOverride, type ProgressionStateResponse, type PurchaseCatalogResponse, type PutSettingRequest, type PutShowcaseRequest, type ReceiptPrincipal, type RecipeAvailabilityResponse, type RecipeExecuteRequest, type RecipeExecuteResponse, type RecipeLockReason, type RecipePrerequisite, type RecipeUsageListResponse, type RecipeUsageResponse, type RoomArgType, type RoomArgsResponse, type RoomArgsTemplate, type SaveDataResponse, type SaveFinalizeRequest, type SaveUploadUrlRequest, type SaveUploadUrlResponse, type SettingResponse, type SettingsListResponse, type ShowcaseValueResponse, type SimulateOrderRequest, type SimulateOrderResponse, type SimulationFailure, type SimulationOutcome, type SimulationOverrides, type SlugOrId, type SubjectIdentityFields, type SuppliedBucketRow, type SuppliedCurrencies, type SuppliedCurrencyRow, type SuppliedInventory, type SuppliedItemRow, type SuppliedItems, type SuppliedPeriodProgressRow, type SuppliedProgressionRow, type SuppliedProgressions, type SuppliedScope, type ThemedColors, type TransferCurrencyRequest, type TransferItemRequest, type TransferResponse, type UnavailabilityReason, type UpdateGameRoomRequest, type UpdateRoomArgsRequest, type WindowKind, type WindowPreviewResponse, type WornAvatar3d, acceptTransfer, addEntityProgression, adminAction, cancelInventoryTransfer, claimEntityProgressionRewards, closeGameRoom, createEntityBatchOrder, createEntityOrder, createSession, deleteEntityGameSetting, deleteEntitySave, deleteSession, deleteShowcaseValue, executeEntityRecipe, finalizeSaveUpload, getChannelAssignment, getDropRates, getEntityCurrency, getEntityGameSetting, getEntityInventory, getEntityInventoryItem, getEntityLeaderboard, getEntityOrder, getEntityProgression, getEntityRecipeAvailability, getEntityRecipeUsage, getEntitySave, getEvent, getGameRoomV2, getLeaderboard, getPlayerGameProfile, getPurchaseCatalog, getResolvedTemplate, getRoomArgs, getShowcaseValue, getTransferDetails, ingestAnalyticsEvents, initiateInventoryTransfer, invokeFunction, kickPlayer, listChallenges, listEntityGameSettings, listEntityOrders, listEntityProgressions, listEntitySaves, listEvents, listGameRooms, listResolvedTemplates, listTransfers, maxEntityProgression, putEntityGameSetting, putRoomArgs, putShowcaseValue, rejectTransfer, reportMatchPlayers, requestSaveUploadUrl, resetEntityProgression, setMatchBackfill, simulateEntityOrder, transferHostV2, updateGameRoomV2 };
|