Skip to content

Modules: Game Shared

Shared remote payload types used across all games (@broblox/game-shared). Status: Implemented (7 types).

Purpose

  • Define common interfaces for remote event payloads so all games use the same shapes.
  • Eliminate duplicated type definitions across game remotes.ts files.
  • Provide a single import source for payload types used by notifications, rewards, and events.

Data model

  • RemoteRewardEntry — type (RewardType), amount, itemId?, label?.
  • LevelUpPayload — newLevel.
  • PrestigeUnlockedPayload — newPrestige.
  • QuestCompletedPayload — questId, rewards: RemoteRewardEntry[].
  • AchievementCompletedPayload — achievementId, rewards: RemoteRewardEntry[].
  • DailyRewardClaimedPayload — day, streak, rewards: RemoteRewardEntry[].
  • EventActivePayload — id, label, modifiers?.

Usage

Games import payload types from @broblox/game-shared in their remotes.ts:

import type {
  RemoteRewardEntry,
  LevelUpPayload,
  QuestCompletedPayload,
} from "@broblox/game-shared";

Dependencies

  • @broblox/rewards — RewardType enum used by RemoteRewardEntry.

Testing

  • Package-level smoke tests ensure the module is importable; exported types are validated via TypeScript compilation in consuming games.

See Also