API کلاینت

createGameClient(options) برای هر پرتاب یک کلاینت برمی‌گرداند.

کیفیت گرافیک

با قابلیت اختیاری graphics-settings-v1 در پروتکل ۲، شِل انتخاب خودکار، کم، متوسط یا زیاد را روی همین دستگاه ذخیره می‌کند. init.graphicsSettings و graphics.settings مقدار preference، quality و revision را می‌فرستند. graphics.settings() را پیش از ساخت صحنه بخوان و با graphics.subscribe تغییرات را اعمال کن. graphics.frame(now, active) فقط فریم‌های حرکت واقعی را می‌سنجد؛ هنگام آماده‌سازی و تغییر اندازه graphics.reset() را صدا بزن. حالت خودکار کیفیت اولیه را از نشانه‌های کلی سخت‌افزار تخمین می‌زند و پس از افت پایدار یک پله کم می‌کند؛ انتخاب دستی ثابت می‌ماند. graphics.applied کاهش خودکار را با revision فعلی گزارش می‌کند. اطلاعات سخت‌افزار از پل عبور نمی‌کند. شوتبال نخستین مصرف‌کننده است.

گزینه‌ها

فیلد	معنی
`protocolVersion`	`1` یا `2`. پیش‌فرض پروتکل ۱.
`capabilities`	نام‌های تبلیغ‌شده روی `ready`.
`deferAssets`	کلیدهای اختیاری نشست که آماده‌سازی آن‌ها به زمان نیاز موکول می‌شود؛ منابع ضروری همیشه آماده می‌شوند. این گزینه محلی SDK است و فیلد manifest یا پیام پل نیست.

متدها

متد	معنی
`ready()`	آمادگی را تبلیغ می‌کند تا `acknowledge`.
`acknowledge()`	تکرار ready را می‌ایستاند و اگر قادر باشد دارایی نشست را آماده می‌کند.
`onMessage(handler)`	اشتراک پیام شِل. تابع لغو برمی‌گرداند.
`send(type, payload)`	ارسال سطح پایین. بهتر است helper تایپ‌شده استفاده شود.
`capabilities()`	قابلیت‌های تأییدشده بعد از `init`.
`presentation()`	صحنه و تم حل‌شده بعد از `init`، یا `null`.
`audio.settings()`	مقدار جاری `{ muted, musicVolume, effectsVolume, ambienceVolume }`.
`toast.show(message, options)`	اعلان شناور شِل. صفحهٔ پیام شناور را ببین.
`toast.info/success/warning/danger(message, options)`	میان‌بر حالت.
`assets.resolve(selector)`	حل انتخابگر کاتالوگ (`assets-v1`).
`assets.load(descriptor)`	واکشی و decode تصویر یا صدا.
`assets.get(key)`	دارایی آماده‌شدهٔ نشست، یا `undefined` اگر بارگذاری اختیاری شکست بخورد.
`assets.prepare(key)`	پس از init و با assets-v1، منبع مجاز نشست را هنگام نیاز با کار همزمان مشترک و onAssetLoaded آماده می‌کند. محدودیت زمان، decode و پاکسازی حفظ می‌شود؛ خطای اختیاری undefined و کلید ناشناخته خطا می‌دهد. درصد اولیه فقط دستهٔ اولیه را می‌شمارد؛ موسیقی دیرهنگام نباید شروع بازی را عقب بیندازد.
`session.checkpoint(events, elapsedMs)`	ذخیرهٔ رویدادهای بازی (`session-v1`).
`session.resume()`	بارگذاری دوبارهٔ نشست عمومی (`session-v1`).
`session.navigate({levelId})`	درخواست دور تازه؛ `null` نقشه است (`session-navigation-v1`).
`purchases.list()`	فهرست پیشنهادهای فعلی (`purchases-v1`).
`purchases.buy(offerId)`	درخواست خرید مطمئن از شِل (`purchases-v1`).
`dispose()`	شنونده‌ها را برمی‌دارد، درخواست‌های باز را رد می‌کند و URL شیء را آزاد می‌کند.

متد قابلیت اگر آن نام تأیید نشده باشد UNSUPPORTED_CAPABILITY پرتاب می‌کند.

خطاها

پاسخ شکست‌خورده با Error به‌علاوهٔ code رد می‌شود. کدهای رایج: INVALID_REQUEST، ASSET_TIMEOUT، ASSET_LOAD_FAILED، CANCELLED و UNSUPPORTED_CAPABILITY.