@indiegems/gem-web-sdk 12.0.0 → 13.0.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 +23 -0
- package/dist/function.d.ts +9 -1
- package/dist/game.d.ts +39 -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 +36 -14
- package/dist/sdk.d.ts +49 -14
- package/dist/server-api.d.ts +9 -1
- package/dist/server.d.ts +10 -1
- package/docs/api/api-reference-function.md +162 -2
- package/docs/api/api-reference-game.md +529 -163
- package/docs/api/api-reference-server.md +1 -1
- package/docs/api/reference.json +773 -176
- package/docs/arcade-avatars.md +303 -0
- package/docs/changelog.md +23 -0
- package/docs/getting-started.md +1 -1
- package/docs/manifest.json +15 -10
- package/docs/saving-player-progress.md +16 -10
- package/docs/server-bundles.md +2 -2
- package/docs/what-a-game-must-do.md +53 -46
- package/package.json +1 -1
- package/schema/bridge.v1.json +198 -18
- package/schema/capabilities.public.json +6 -0
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" | (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;
|
|
@@ -4514,8 +4550,7 @@ declare class GemFrame {
|
|
|
4514
4550
|
setWalletVisible(visible: boolean, options?: {
|
|
4515
4551
|
only?: readonly string[];
|
|
4516
4552
|
}): boolean;
|
|
4517
|
-
|
|
4518
|
-
setMenu(settings: boolean, items?: ReadonlyArray<{
|
|
4553
|
+
setMenu(items?: ReadonlyArray<{
|
|
4519
4554
|
readonly id: string;
|
|
4520
4555
|
readonly label: string;
|
|
4521
4556
|
}>): boolean;
|
|
@@ -4534,6 +4569,7 @@ declare class GemFrame {
|
|
|
4534
4569
|
dedicatedOffer(matchId: string, sdp: string, intent: GemDedicatedOffer["intent"]): void;
|
|
4535
4570
|
requestParty(requestId: string): boolean;
|
|
4536
4571
|
requestPurchase(requestId: string, purchaseKind: "item" | "recipe", targetId: string, currencySlug: string, quantity?: number, catalogId?: string): boolean;
|
|
4572
|
+
requestAvatar3dPurchase(requestId: string, itemId: string, currencySlug: string): boolean;
|
|
4537
4573
|
putDeviceSettings(requestId: string, settings: Readonly<Record<string, unknown>>): boolean;
|
|
4538
4574
|
requestAd(requestId: string, placement: string, format: "interstitial" | "rewarded"): boolean;
|
|
4539
4575
|
requestSignIn(requestId: string): boolean;
|
|
@@ -4587,7 +4623,6 @@ interface GemLook {
|
|
|
4587
4623
|
set(options: GemLookOptions): void;
|
|
4588
4624
|
}
|
|
4589
4625
|
interface ControlsApi {
|
|
4590
|
-
declare(uses: GemControlsDeclaration): boolean;
|
|
4591
4626
|
look(options?: GemLookOptions): GemLook;
|
|
4592
4627
|
readonly LOOK_BASE: GemLookBase;
|
|
4593
4628
|
}
|
|
@@ -4715,7 +4750,6 @@ interface GameMenuItem {
|
|
|
4715
4750
|
readonly onSelect: () => void;
|
|
4716
4751
|
}
|
|
4717
4752
|
interface GameMenu {
|
|
4718
|
-
readonly onSettings?: () => void;
|
|
4719
4753
|
readonly items?: readonly GameMenuItem[];
|
|
4720
4754
|
}
|
|
4721
4755
|
interface GemTerminationNotice {
|
|
@@ -4746,6 +4780,7 @@ interface Gem {
|
|
|
4746
4780
|
openAvatarPicker(options?: {
|
|
4747
4781
|
readonly tab?: "2d" | "3d";
|
|
4748
4782
|
}): boolean;
|
|
4783
|
+
readonly avatars3d: Avatars3dApi;
|
|
4749
4784
|
readonly vibration: VibrationApi;
|
|
4750
4785
|
readonly controls: ControlsApi;
|
|
4751
4786
|
readonly analytics: AnalyticsApi;
|
|
@@ -4792,4 +4827,4 @@ interface ExitAnalytics {
|
|
|
4792
4827
|
}
|
|
4793
4828
|
declare function leaveAndExit(rooms: ExitRooms, bridge: ExitBridge | null, reason?: string, analytics?: ExitAnalytics): Promise<void>;
|
|
4794
4829
|
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
|
|
4830
|
+
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 Avatar3dFamily, type Avatar3dOffer, type Avatar3dPrice, type Avatar3dPurchaseRequest, 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 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 };
|
package/dist/server.d.ts
CHANGED
|
@@ -860,6 +860,7 @@ type PlayerIdentityFields = {
|
|
|
860
860
|
"avatar_3d_model_url"?: string | null;
|
|
861
861
|
"avatar_icon_id"?: string | null;
|
|
862
862
|
"avatar_icon_url"?: string | null;
|
|
863
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
863
864
|
"badges"?: PlayerBadge[];
|
|
864
865
|
"discriminator"?: string | null;
|
|
865
866
|
"display_name"?: string | null;
|
|
@@ -1087,6 +1088,7 @@ type SubjectIdentityFields = {
|
|
|
1087
1088
|
"avatar_3d_model_url"?: string | null;
|
|
1088
1089
|
"avatar_icon_id"?: string | null;
|
|
1089
1090
|
"avatar_icon_url"?: string | null;
|
|
1091
|
+
"avatars_3d"?: WornAvatar3d[] | null;
|
|
1090
1092
|
"badges": PlayerBadge[];
|
|
1091
1093
|
"discriminator"?: string | null;
|
|
1092
1094
|
"display_name"?: string | null;
|
|
@@ -1248,6 +1250,12 @@ type WindowPreviewResponse = {
|
|
|
1248
1250
|
"ends_at": string;
|
|
1249
1251
|
"starts_at": string;
|
|
1250
1252
|
};
|
|
1253
|
+
type WornAvatar3d = {
|
|
1254
|
+
"avatar_3d_id": string;
|
|
1255
|
+
"family": string;
|
|
1256
|
+
"icon_url": string;
|
|
1257
|
+
"model_url": string;
|
|
1258
|
+
};
|
|
1251
1259
|
declare function acceptTransfer(api: GameApi, transfer_id: string, options?: {
|
|
1252
1260
|
signal?: AbortSignal;
|
|
1253
1261
|
}): Promise<TransferResponse>;
|
|
@@ -1627,6 +1635,7 @@ type generated_UpdateGameRoomRequest = UpdateGameRoomRequest;
|
|
|
1627
1635
|
type generated_UpdateRoomArgsRequest = UpdateRoomArgsRequest;
|
|
1628
1636
|
type generated_WindowKind = WindowKind;
|
|
1629
1637
|
type generated_WindowPreviewResponse = WindowPreviewResponse;
|
|
1638
|
+
type generated_WornAvatar3d = WornAvatar3d;
|
|
1630
1639
|
declare const generated_acceptTransfer: typeof acceptTransfer;
|
|
1631
1640
|
declare const generated_addEntityProgression: typeof addEntityProgression;
|
|
1632
1641
|
declare const generated_adminAction: typeof adminAction;
|
|
@@ -1689,7 +1698,7 @@ declare const generated_simulateEntityOrder: typeof simulateEntityOrder;
|
|
|
1689
1698
|
declare const generated_transferHostV2: typeof transferHostV2;
|
|
1690
1699
|
declare const generated_updateGameRoomV2: typeof updateGameRoomV2;
|
|
1691
1700
|
declare namespace generated {
|
|
1692
|
-
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 AnalyticsRejection$1 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 };
|
|
1701
|
+
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 AnalyticsRejection$1 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 };
|
|
1693
1702
|
}
|
|
1694
1703
|
type AnalyticsValue = string | number;
|
|
1695
1704
|
interface AnalyticsRejection {
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The function surface — API reference
|
|
2
2
|
|
|
3
|
-
Generated from `@indiegems/gem-web-sdk/function`
|
|
3
|
+
Generated from `@indiegems/gem-web-sdk/function` v13.0.0, the version of the package this file ships in. Every symbol below carries an explicit anchor, its `anchor` in `reference.json` beside this file.
|
|
4
4
|
|
|
5
5
|
`@indiegems/gem-web-sdk/function` exports exactly the symbols on this page and nothing else.
|
|
6
6
|
|
|
@@ -3957,6 +3957,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
3957
3957
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
3958
3958
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
3959
3959
|
|
|
3960
|
+
<a id="friend-avatars3d"></a>
|
|
3961
|
+
|
|
3962
|
+
## Friend.avatars3d
|
|
3963
|
+
|
|
3964
|
+
```ts
|
|
3965
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
3966
|
+
```
|
|
3967
|
+
|
|
3968
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
3969
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
3970
|
+
default look.
|
|
3971
|
+
|
|
3972
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
3973
|
+
avatar of the game's first declared family that has one. A game that
|
|
3974
|
+
accepts a single family can read either; one that accepts several picks by
|
|
3975
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
3976
|
+
the flat fields then.
|
|
3977
|
+
|
|
3960
3978
|
<a id="friend-badges"></a>
|
|
3961
3979
|
|
|
3962
3980
|
## Friend.badges
|
|
@@ -4861,6 +4879,76 @@ readonly iconUrl: string
|
|
|
4861
4879
|
The badge's thumbnail. Pass it through [platformIconUrl](#platformiconurl) before
|
|
4862
4880
|
putting it in an `<img src>`.
|
|
4863
4881
|
|
|
4882
|
+
<a id="avatar3dfamily"></a>
|
|
4883
|
+
|
|
4884
|
+
## Avatar3dFamily
|
|
4885
|
+
|
|
4886
|
+
```ts
|
|
4887
|
+
type Avatar3dFamily = "small_human" | string & object
|
|
4888
|
+
```
|
|
4889
|
+
|
|
4890
|
+
A rig family — the skeleton contract a 3D avatar is built on, and what a
|
|
4891
|
+
game declares it can animate. `small_human` is the first: a `root` node
|
|
4892
|
+
with a `body` child, which holds `head`, `arm_l`, `arm_r`, `leg_l` and
|
|
4893
|
+
`leg_r`, and a `hand_socket` under `arm_r`.
|
|
4894
|
+
|
|
4895
|
+
Open-ended (`| (string & {})`) so a family the platform adds later does not
|
|
4896
|
+
break a `switch` you compiled against this version: keep a `default` arm and
|
|
4897
|
+
skip a family you do not draw.
|
|
4898
|
+
|
|
4899
|
+
<a id="wornavatar3d"></a>
|
|
4900
|
+
|
|
4901
|
+
## WornAvatar3d
|
|
4902
|
+
|
|
4903
|
+
```ts
|
|
4904
|
+
interface WornAvatar3d
|
|
4905
|
+
```
|
|
4906
|
+
|
|
4907
|
+
One 3D avatar a player wears — at most one per [Avatar3dFamily](#avatar3dfamily).
|
|
4908
|
+
|
|
4909
|
+
<a id="wornavatar3d-family"></a>
|
|
4910
|
+
|
|
4911
|
+
## WornAvatar3d.family
|
|
4912
|
+
|
|
4913
|
+
```ts
|
|
4914
|
+
readonly family: Avatar3dFamily
|
|
4915
|
+
```
|
|
4916
|
+
|
|
4917
|
+
The rig family this avatar is built on.
|
|
4918
|
+
|
|
4919
|
+
<a id="wornavatar3d-id"></a>
|
|
4920
|
+
|
|
4921
|
+
## WornAvatar3d.id
|
|
4922
|
+
|
|
4923
|
+
```ts
|
|
4924
|
+
readonly id: string
|
|
4925
|
+
```
|
|
4926
|
+
|
|
4927
|
+
The avatar's item id — a stable key for the model, never something to
|
|
4928
|
+
show as text.
|
|
4929
|
+
|
|
4930
|
+
<a id="wornavatar3d-modelurl"></a>
|
|
4931
|
+
|
|
4932
|
+
## WornAvatar3d.modelUrl
|
|
4933
|
+
|
|
4934
|
+
```ts
|
|
4935
|
+
readonly modelUrl: string
|
|
4936
|
+
```
|
|
4937
|
+
|
|
4938
|
+
The avatar's model, a binary glTF (`.glb`) on the family's rig. Pass it
|
|
4939
|
+
through [platformIconUrl](#platformiconurl) before loading it.
|
|
4940
|
+
|
|
4941
|
+
<a id="wornavatar3d-iconurl"></a>
|
|
4942
|
+
|
|
4943
|
+
## WornAvatar3d.iconUrl
|
|
4944
|
+
|
|
4945
|
+
```ts
|
|
4946
|
+
readonly iconUrl: string
|
|
4947
|
+
```
|
|
4948
|
+
|
|
4949
|
+
A rendered portrait of the avatar, for a roster or a menu. Pass it through
|
|
4950
|
+
[platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
4951
|
+
|
|
4864
4952
|
<a id="playeridentity"></a>
|
|
4865
4953
|
|
|
4866
4954
|
## PlayerIdentity
|
|
@@ -5004,6 +5092,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
5004
5092
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
5005
5093
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
5006
5094
|
|
|
5095
|
+
<a id="playeridentity-avatars3d"></a>
|
|
5096
|
+
|
|
5097
|
+
## PlayerIdentity.avatars3d
|
|
5098
|
+
|
|
5099
|
+
```ts
|
|
5100
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
5101
|
+
```
|
|
5102
|
+
|
|
5103
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
5104
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
5105
|
+
default look.
|
|
5106
|
+
|
|
5107
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
5108
|
+
avatar of the game's first declared family that has one. A game that
|
|
5109
|
+
accepts a single family can read either; one that accepts several picks by
|
|
5110
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
5111
|
+
the flat fields then.
|
|
5112
|
+
|
|
5007
5113
|
<a id="playeridentity-badges"></a>
|
|
5008
5114
|
|
|
5009
5115
|
## PlayerIdentity.badges
|
|
@@ -5043,7 +5149,7 @@ for (const row of opponents) {
|
|
|
5043
5149
|
|
|
5044
5150
|
Reads `player_id`, `display_name`, `discriminator`, `display_tag`,
|
|
5045
5151
|
`avatar_icon_id`, `avatar_icon_url`, `avatar_3d_id`, `avatar_3d_model_url`,
|
|
5046
|
-
`avatar_3d_icon_url` and `badges`, and nothing else from the row. Anything missing, empty or of the wrong type is absent in the result.
|
|
5152
|
+
`avatar_3d_icon_url`, `avatars_3d` and `badges`, and nothing else from the row. Anything missing, empty or of the wrong type is absent in the result.
|
|
5047
5153
|
|
|
5048
5154
|
| Parameter | Type |
|
|
5049
5155
|
| --- | --- |
|
|
@@ -5336,6 +5442,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
5336
5442
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
5337
5443
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
5338
5444
|
|
|
5445
|
+
<a id="leaderboardentry-avatars3d"></a>
|
|
5446
|
+
|
|
5447
|
+
## LeaderboardEntry.avatars3d
|
|
5448
|
+
|
|
5449
|
+
```ts
|
|
5450
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
5451
|
+
```
|
|
5452
|
+
|
|
5453
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
5454
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
5455
|
+
default look.
|
|
5456
|
+
|
|
5457
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
5458
|
+
avatar of the game's first declared family that has one. A game that
|
|
5459
|
+
accepts a single family can read either; one that accepts several picks by
|
|
5460
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
5461
|
+
the flat fields then.
|
|
5462
|
+
|
|
5339
5463
|
<a id="leaderboardentry-badges"></a>
|
|
5340
5464
|
|
|
5341
5465
|
## LeaderboardEntry.badges
|
|
@@ -6868,6 +6992,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
6868
6992
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
6869
6993
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
6870
6994
|
|
|
6995
|
+
<a id="playerprofile-avatars3d"></a>
|
|
6996
|
+
|
|
6997
|
+
## PlayerProfile.avatars3d
|
|
6998
|
+
|
|
6999
|
+
```ts
|
|
7000
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
7001
|
+
```
|
|
7002
|
+
|
|
7003
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
7004
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
7005
|
+
default look.
|
|
7006
|
+
|
|
7007
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
7008
|
+
avatar of the game's first declared family that has one. A game that
|
|
7009
|
+
accepts a single family can read either; one that accepts several picks by
|
|
7010
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
7011
|
+
the flat fields then.
|
|
7012
|
+
|
|
6871
7013
|
<a id="playerprofile-badges"></a>
|
|
6872
7014
|
|
|
6873
7015
|
## PlayerProfile.badges
|
|
@@ -7231,6 +7373,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
7231
7373
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
7232
7374
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
7233
7375
|
|
|
7376
|
+
<a id="showcasefriendentry-avatars3d"></a>
|
|
7377
|
+
|
|
7378
|
+
## ShowcaseFriendEntry.avatars3d
|
|
7379
|
+
|
|
7380
|
+
```ts
|
|
7381
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
7382
|
+
```
|
|
7383
|
+
|
|
7384
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
7385
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
7386
|
+
default look.
|
|
7387
|
+
|
|
7388
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
7389
|
+
avatar of the game's first declared family that has one. A game that
|
|
7390
|
+
accepts a single family can read either; one that accepts several picks by
|
|
7391
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
7392
|
+
the flat fields then.
|
|
7393
|
+
|
|
7234
7394
|
<a id="showcasefriendentry-badges"></a>
|
|
7235
7395
|
|
|
7236
7396
|
## ShowcaseFriendEntry.badges
|