@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/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.1.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,84 @@ 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" | "adult_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. Two today:
|
|
4892
|
+
|
|
4893
|
+
- `small_human`, the toy rig: a `root` node with a `body` child, which holds
|
|
4894
|
+
`head`, `arm_l`, `arm_r`, `leg_l` and `leg_r`, and a `hand_socket` under
|
|
4895
|
+
`arm_r`.
|
|
4896
|
+
- `adult_human`, a full humanoid with fingers: 56 nodes from `root` and
|
|
4897
|
+
`hips` down to `toes_r`, every one world-aligned at rest, so one clip plays
|
|
4898
|
+
on every avatar in the family.
|
|
4899
|
+
|
|
4900
|
+
`AVATAR_RIGS` (from `@indiegems/gem-web-sdk/sdk`) lists every node of
|
|
4901
|
+
both, with its parent.
|
|
4902
|
+
|
|
4903
|
+
Open-ended (`| (string & {})`) so a family the platform adds later does not
|
|
4904
|
+
break a `switch` you compiled against this version: keep a `default` arm and
|
|
4905
|
+
skip a family you do not draw.
|
|
4906
|
+
|
|
4907
|
+
<a id="wornavatar3d"></a>
|
|
4908
|
+
|
|
4909
|
+
## WornAvatar3d
|
|
4910
|
+
|
|
4911
|
+
```ts
|
|
4912
|
+
interface WornAvatar3d
|
|
4913
|
+
```
|
|
4914
|
+
|
|
4915
|
+
One 3D avatar a player wears — at most one per [Avatar3dFamily](#avatar3dfamily).
|
|
4916
|
+
|
|
4917
|
+
<a id="wornavatar3d-family"></a>
|
|
4918
|
+
|
|
4919
|
+
## WornAvatar3d.family
|
|
4920
|
+
|
|
4921
|
+
```ts
|
|
4922
|
+
readonly family: Avatar3dFamily
|
|
4923
|
+
```
|
|
4924
|
+
|
|
4925
|
+
The rig family this avatar is built on.
|
|
4926
|
+
|
|
4927
|
+
<a id="wornavatar3d-id"></a>
|
|
4928
|
+
|
|
4929
|
+
## WornAvatar3d.id
|
|
4930
|
+
|
|
4931
|
+
```ts
|
|
4932
|
+
readonly id: string
|
|
4933
|
+
```
|
|
4934
|
+
|
|
4935
|
+
The avatar's item id — a stable key for the model, never something to
|
|
4936
|
+
show as text.
|
|
4937
|
+
|
|
4938
|
+
<a id="wornavatar3d-modelurl"></a>
|
|
4939
|
+
|
|
4940
|
+
## WornAvatar3d.modelUrl
|
|
4941
|
+
|
|
4942
|
+
```ts
|
|
4943
|
+
readonly modelUrl: string
|
|
4944
|
+
```
|
|
4945
|
+
|
|
4946
|
+
The avatar's model, a binary glTF (`.glb`) on the family's rig. Pass it
|
|
4947
|
+
through [platformIconUrl](#platformiconurl) before loading it.
|
|
4948
|
+
|
|
4949
|
+
<a id="wornavatar3d-iconurl"></a>
|
|
4950
|
+
|
|
4951
|
+
## WornAvatar3d.iconUrl
|
|
4952
|
+
|
|
4953
|
+
```ts
|
|
4954
|
+
readonly iconUrl: string
|
|
4955
|
+
```
|
|
4956
|
+
|
|
4957
|
+
A rendered portrait of the avatar, for a roster or a menu. Pass it through
|
|
4958
|
+
[platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
4959
|
+
|
|
4864
4960
|
<a id="playeridentity"></a>
|
|
4865
4961
|
|
|
4866
4962
|
## PlayerIdentity
|
|
@@ -5004,6 +5100,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
5004
5100
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
5005
5101
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
5006
5102
|
|
|
5103
|
+
<a id="playeridentity-avatars3d"></a>
|
|
5104
|
+
|
|
5105
|
+
## PlayerIdentity.avatars3d
|
|
5106
|
+
|
|
5107
|
+
```ts
|
|
5108
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
5109
|
+
```
|
|
5110
|
+
|
|
5111
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
5112
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
5113
|
+
default look.
|
|
5114
|
+
|
|
5115
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
5116
|
+
avatar of the game's first declared family that has one. A game that
|
|
5117
|
+
accepts a single family can read either; one that accepts several picks by
|
|
5118
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
5119
|
+
the flat fields then.
|
|
5120
|
+
|
|
5007
5121
|
<a id="playeridentity-badges"></a>
|
|
5008
5122
|
|
|
5009
5123
|
## PlayerIdentity.badges
|
|
@@ -5043,7 +5157,7 @@ for (const row of opponents) {
|
|
|
5043
5157
|
|
|
5044
5158
|
Reads `player_id`, `display_name`, `discriminator`, `display_tag`,
|
|
5045
5159
|
`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.
|
|
5160
|
+
`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
5161
|
|
|
5048
5162
|
| Parameter | Type |
|
|
5049
5163
|
| --- | --- |
|
|
@@ -5336,6 +5450,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
5336
5450
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
5337
5451
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
5338
5452
|
|
|
5453
|
+
<a id="leaderboardentry-avatars3d"></a>
|
|
5454
|
+
|
|
5455
|
+
## LeaderboardEntry.avatars3d
|
|
5456
|
+
|
|
5457
|
+
```ts
|
|
5458
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
5459
|
+
```
|
|
5460
|
+
|
|
5461
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
5462
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
5463
|
+
default look.
|
|
5464
|
+
|
|
5465
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
5466
|
+
avatar of the game's first declared family that has one. A game that
|
|
5467
|
+
accepts a single family can read either; one that accepts several picks by
|
|
5468
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
5469
|
+
the flat fields then.
|
|
5470
|
+
|
|
5339
5471
|
<a id="leaderboardentry-badges"></a>
|
|
5340
5472
|
|
|
5341
5473
|
## LeaderboardEntry.badges
|
|
@@ -6868,6 +7000,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
6868
7000
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
6869
7001
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
6870
7002
|
|
|
7003
|
+
<a id="playerprofile-avatars3d"></a>
|
|
7004
|
+
|
|
7005
|
+
## PlayerProfile.avatars3d
|
|
7006
|
+
|
|
7007
|
+
```ts
|
|
7008
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
7009
|
+
```
|
|
7010
|
+
|
|
7011
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
7012
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
7013
|
+
default look.
|
|
7014
|
+
|
|
7015
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
7016
|
+
avatar of the game's first declared family that has one. A game that
|
|
7017
|
+
accepts a single family can read either; one that accepts several picks by
|
|
7018
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
7019
|
+
the flat fields then.
|
|
7020
|
+
|
|
6871
7021
|
<a id="playerprofile-badges"></a>
|
|
6872
7022
|
|
|
6873
7023
|
## PlayerProfile.badges
|
|
@@ -7231,6 +7381,24 @@ loading the model is too much. Not the 2D portrait
|
|
|
7231
7381
|
([PlayerIdentity.avatarIconUrl](#playeridentity-avatariconurl)), which is a separate choice. Pass it
|
|
7232
7382
|
through [platformIconUrl](#platformiconurl) before putting it in an `<img src>`.
|
|
7233
7383
|
|
|
7384
|
+
<a id="showcasefriendentry-avatars3d"></a>
|
|
7385
|
+
|
|
7386
|
+
## ShowcaseFriendEntry.avatars3d
|
|
7387
|
+
|
|
7388
|
+
```ts
|
|
7389
|
+
readonly avatars3d?: readonly WornAvatar3d[]
|
|
7390
|
+
```
|
|
7391
|
+
|
|
7392
|
+
Every 3D avatar the player wears, one per rig family, in the order the game
|
|
7393
|
+
declared its families. Absent or empty means none is worn — draw your
|
|
7394
|
+
default look.
|
|
7395
|
+
|
|
7396
|
+
[PlayerIdentity.avatar3dId](#playeridentity-avatar3did) and its two URLs are one of these: the
|
|
7397
|
+
avatar of the game's first declared family that has one. A game that
|
|
7398
|
+
accepts a single family can read either; one that accepts several picks by
|
|
7399
|
+
`family` here. Absent too where the platform does not send it yet — read
|
|
7400
|
+
the flat fields then.
|
|
7401
|
+
|
|
7234
7402
|
<a id="showcasefriendentry-badges"></a>
|
|
7235
7403
|
|
|
7236
7404
|
## ShowcaseFriendEntry.badges
|