globals.d.ts 2.4 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889
  1. import { SimpleAudioAPI } from "./audio";
  2. import { ConfigAPI } from "./config";
  3. import { EngineAPI } from "./engine";
  4. import { MacroAPI } from "./macro";
  5. import { SaveAPI } from "./save";
  6. import { ScriptingAPI } from "./scripting";
  7. import { SettingsAPI } from "./settings";
  8. import { StateAPI } from "./state";
  9. import { StoryAPI } from "./story";
  10. import { SugarCubeObject } from "./sugarcube";
  11. import { TemplateAPI } from "./template";
  12. import { DialogAPI, FullscreenAPI, LoadScreenAPI, UIAPI, UIBarAPI } from "./ui";
  13. import { SugarCubeSettingVariables, SugarCubeSetupObject } from "./userdata";
  14. import { WikifierAPI } from "./wiki";
  15. declare global {
  16. const SugarCube: SugarCubeObject;
  17. /**
  18. * Configuration API.
  19. * @since 2.0.0
  20. */
  21. const Config: ConfigAPI;
  22. /**
  23. * Dialog API.
  24. * @since 2.0.0
  25. */
  26. const Dialog: DialogAPI;
  27. /**
  28. * Engine API.
  29. */
  30. const Engine: EngineAPI;
  31. /**
  32. * Macro API.
  33. * @since 2.0.0
  34. */
  35. const Macro: MacroAPI;
  36. /**
  37. * @since 2.28.0
  38. */
  39. const SimpleAudio: SimpleAudioAPI;
  40. /**
  41. * Template API.
  42. * @since 2.29.0
  43. */
  44. const Template: TemplateAPI;
  45. /**
  46. * Strings localization object.
  47. * @since 2.10.0
  48. */
  49. const l10nStrings: { [x: string]: string };
  50. /**
  51. * Object that authors/developers may use to set up various bits of static data. Generally, you would use this for data that
  52. * does not change and should not be stored within story variables, which would make it part of the history.
  53. * @since 2.0.0
  54. */
  55. const setup: SugarCubeSetupObject;
  56. /**
  57. * A prototype-less generic object whose properties and values are defined by the Setting.addToggle(),
  58. * Setting.addList(), and Setting.addRange() methods.
  59. *
  60. * Normally, the values of its properties are automatically managed by their associated Settings dialog
  61. * control. If necessary, however, you may manually change their values—n.b. you'll need to call the
  62. * Setting.save() after having done so.
  63. * @since 2.0.0
  64. */
  65. const settings: SugarCubeSettingVariables;
  66. const Fullscreen: FullscreenAPI;
  67. const LoadScreen: LoadScreenAPI;
  68. const Save: SaveAPI;
  69. const Scripting: ScriptingAPI;
  70. const Setting: SettingsAPI;
  71. const State: StateAPI;
  72. const Story: StoryAPI;
  73. const UI: UIAPI;
  74. const UIBar: UIBarAPI;
  75. const Wikifier: WikifierAPI;
  76. }
  77. export {};