userdata.d.ts 1.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. interface VariablesMapBase {
  2. [x: string]: any;
  3. }
  4. /**
  5. * This is a dummy interface for the 'setup' object. Its sole purpose is to be merged
  6. * with user declarations that provide its real game content.
  7. *
  8. * @example
  9. * a_project_file.d.ts:
  10. * declare module "twine-sugarcube" {
  11. * export interface SugarCubeSetupObject {
  12. * player: App.Entity.Player;
  13. * loot: App.LootManager;
  14. * }
  15. *
  16. * export { };
  17. */
  18. // eslint-disable-next-line @typescript-eslint/no-empty-interface
  19. export interface SugarCubeSetupObject {
  20. }
  21. /**
  22. * This is a dummy interface for the story variables object. Its sole purpose is to be merged
  23. * with user declarations that provide its real game content.
  24. *
  25. * @example
  26. * a_project_file.d.ts:
  27. * declare module "twine-sugarcube" {
  28. * export interface SugarCubeStoryVariables {
  29. * location: string;
  30. * hasKey: boolean;
  31. * }
  32. *
  33. * export { };
  34. */
  35. // eslint-disable-next-line @typescript-eslint/no-empty-interface
  36. export interface SugarCubeStoryVariables {
  37. }
  38. // eslint-disable-next-line @typescript-eslint/no-empty-interface
  39. export interface SugarCubeTemporaryVariables extends VariablesMapBase {
  40. }
  41. /**
  42. * This is a dummy interface for the game settings object. Its sole purpose is to be merged
  43. * with user declarations that provide its real game content.
  44. *
  45. * @example
  46. * a_project_file.d.ts:
  47. * declare module "twine-sugarcube" {
  48. * export interface SugarCubeSettingVariables {
  49. * backgroundMusicVolume: number;
  50. * showHints: boolean;
  51. * }
  52. *
  53. * export { };
  54. */
  55. // eslint-disable-next-line @typescript-eslint/no-empty-interface
  56. export interface SugarCubeSettingVariables {
  57. }
  58. export {};