ruffle/web/packages/core/src/config.ts

27 lines
703 B
TypeScript
Raw Normal View History

/**
* Represents the various types of auto-play behaviours that are supported.
*/
import type { BaseLoadOptions } from "./load-options";
2020-11-17 21:01:56 +00:00
/**
* The configuration object to control Ruffle's behaviour on the website
* that it is included on.
*/
export interface Config extends BaseLoadOptions {
2020-11-17 21:01:56 +00:00
/**
* The URL at which Ruffle can load its extra files (i.e. `.wasm`).
2020-11-17 21:01:56 +00:00
*/
publicPath?: string;
2020-11-17 21:05:25 +00:00
/**
* Whether or not to enable polyfills on the page.
*
* Polyfills will look for "legacy" flash content like `<object>`
* and `<embed>` elements, and replace them with compatible
* Ruffle elements.
*
* @default true
*/
polyfills?: boolean;
2020-11-17 21:01:56 +00:00
}