bc-stubs 96.0.0

package/bc/Scripts/DynamicDraw.d.ts

@@ -0,0 +1,310 @@
+/**
+ * Pre-loads a font family and calculates font measurements for the family. This should generally be called in an item's load function so
+ * that font data is loaded in preparation for dynamic font drawing. This will also be called at draw-time, but if the font is already
+ * pre-loaded, this function will do nothing.
+ * @param {string} fontFamily - the font family to load. Can be a single font name or a full CSS font stack
+ * (e.g. "'Helvetica', 'Arial', sans-serif")
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawLoadFont(fontFamily: string): void;
+/**
+ * Draws the given text to the provided canvas rendering context at the given positions. Text is drawn horizontally, respecting the
+ * configuration in the provided options (if any).
+ * @param {string} text - The text to draw
+ * @param {CanvasRenderingContext2D} ctx - The rendering context to draw the text to
+ * @param {number} x - The x coordinate at which to draw the text
+ * @param {number} y - The y coordinate at which to draw the text
+ * @param {DynamicDrawOptions} options - Additional drawing options
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawText(text: string, ctx: CanvasRenderingContext2D, x: number, y: number, options: DynamicDrawOptions): void;
+/**
+ * Draws the given text in a straight line between the two provided coordinates. If the contain option is specified, the text will be fully
+ * contained in the rectangle defined by the from and to positions.
+ * @param {string} text - The text to draw
+ * @param {CanvasRenderingContext2D} ctx - The rendering context to draw the text to
+ * @param {readonly number[]} from - The [x, y] coordinates to start drawing the text at
+ * @param {readonly number[]} to - The [x, y] coordinates to end drawing the text at
+ * @param {DynamicDrawOptions} options - Additional drawing options
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawTextFromTo(text: string, ctx: CanvasRenderingContext2D, from: readonly number[], to: readonly number[], options: DynamicDrawOptions): void;
+/**
+ * Draws the given text in a circular arc at the given [x, y] coordinate. The text will be drawn so that the center of the text is
+ * positioned on the given coordinates.
+ * @see {@link DynamicDrawOptions}
+ * @param {string} text - The text to draw
+ * @param {CanvasRenderingContext2D} ctx - The rendering context to draw the text to
+ * @param {number} x - The x coordinate at which to center the text
+ * @param {number} y - The y coordinate at which to center the text
+ * @param {DynamicDrawOptions} options - Additional drawing options. These can be used to specify the radius of the circle (determining how
+ * curved the text appears), as well as the direction along the circle that the text is drawn in (by default, text is drawn clockwise).
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawTextArc(text: string, ctx: CanvasRenderingContext2D, x: number, y: number, options: DynamicDrawOptions): void;
+/**
+ * Internal utility function for drawing text and applying text effects.
+ * @param {string} text - The text to draw
+ * @param {CanvasRenderingContext2D} ctx - The rendering context to draw the text to
+ * @param {number} x - The x coordinate at which to draw the text
+ * @param {number} y - The y coordinate at which to draw the text
+ * @param {DynamicDrawOptions} options - Additional drawing options
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawTextAndEffects(text: string, ctx: CanvasRenderingContext2D, x: number, y: number, options: DynamicDrawOptions): void;
+/**
+ * Parses a dynamic drawing options object, returning default values for properties that aren't defined.
+ * @param {DynamicDrawOptions} [options] - The options object to parse
+ * @returns {DynamicDrawOptions} - A complete options object, with default values where not specified
+ */
+declare function DynamicDrawParseOptions(options?: DynamicDrawOptions): DynamicDrawOptions;
+/**
+ * Applies a set of dynamic drawing options to a canvas rendering context. This sets the canvas up with the relevant font size, color, etc.
+ * ready for drawing text
+ * @param {CanvasRenderingContext2D} ctx - The rendering context to draw the text to
+ * @param {DynamicDrawOptions} options - The drawing options to apply
+ * @returns {void} - Nothing
+ */
+declare function DynamicDrawApplyOptions(ctx: CanvasRenderingContext2D, { fontSize, fontFamily, textAlign, textBaseline, color, strokeColor, strokeWidth }: DynamicDrawOptions): void;
+/**
+ * DynamicDraw.js
+ * --------------
+ * This file contains common utilities for dynamically drawing text onto assets.
+ *
+ * An options hash that can be used to customize dynamically drawn text. No options need be specified, and some options are only applicable
+ * to certain drawing functions.
+ * @typedef DynamicDrawOptions
+ * @type {object}
+ * @property {number} [fontSize] - The target font size. Note that if space is constrained, the actual drawn font size will be reduced
+ * automatically to fit. Defaults to 30px.
+ * @property {string} [fontFamily] - The desired font family to draw text in. This can be a single font name, or a full CSS font stack
+ * (e.g. "'Helvetica', 'Arial', sans-serif"). Defaults to the player's chosen global font.
+ * @property {CanvasTextAlign} [textAlign] - The text alignment to use. Can be any valid
+ * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/text-align text alignment}. Not applicable to the {@link DynamicDrawTextArc}
+ * function. Defaults to "center".
+ * @property {CanvasTextBaseline} [textBaseline] - The text baseline to use. Can be any valid
+ * {@link https://developer.mozilla.org/en-us/docs/Web/CSS/vertical-align vertical alignment}. Defaults to "middle".
+ * @property {string} [color] - The color that the text should be drawn in. Can be any valid CSS color string. Defaults to "#000".
+ * @property {string} [strokeColor] - The stroke color that should be used for the text. Can be any valid CSS color
+ * string. Defaults to the same value as the `color` property.
+ * @property {number} [strokeWidth] - The stroke width that should be used when stroking the text. Only used if a `strokeColor` is defined. Defaults to 1.
+ * @property {DynamicDrawTextEffect} [effect] - A dynamic text effect to apply. No effects are applied by default.
+ * @property {number} [width] - The maximum width of the drawn text. Not applicable to the {@link DynamicDrawTextFromTo} function, as
+ * constraints are defined by the endpoints. When defined for the {@link DynamicDrawTextArc} function, it defines the maximum width of the
+ * text perpendicular to the radius line on which the text is centered. Unlimited by default.
+ * @property {boolean} [contain] - Whether or not the text should be fully contained in the box defined by the from/to coordinates. Only
+ * applicable to the {@link DynamicDrawTextFromTo} function. Defaults to true.
+ * @property {number} [angle] - The angle at which the text should be drawn, relative to the center of the circle. Angles are measured
+ * clockwise in radians starting at the vertical 12 o'clock position. For example 0 corresponds to 12 o'clock, PI/2 corresponds to
+ * 3 o'clock, PI corresponds to 6 o'clock, and 3PI/2 corresponds to 9 o'clock. Only applicable to the {@link DynamicDrawTextArc} function.
+ * Defaults to 0.
+ * @property {number} [radius] - The radius in pixels of the circle whose arc the text should be drawn along. A smaller radius will result
+ * in a greater text curvature and vice versa. Only applicable to the {@link DynamicDrawTextArc} function. Defaults to 450px.
+ * @property {number} [maxAngle] - The maximum angle that the text should be drawn along. This effectively determines the maximum length of
+ * the arc along which the text will be drawn. Only applicable to the {@link DynamicDrawTextArc} function. Defaults to PI (a semicircle).
+ * @property {DynamicDrawTextDirection} [direction] - The direction the text should be drawn in along the circular arc. Only applicable to
+ * the {@link DynamicDrawTextArc} function. Defaults to {@link DynamicDrawTextDirection.CLOCKWISE};
+ * @property {DynamicDrawTextCurve} [textCurve] - The direction of the curve of the text. This determines whether the center of the text
+ * curves upwards ({@link DynamicDrawTextCurve.SMILEY}) or downwards ({@link DynamicDrawTextCurve.FROWNY}). Only applicable to the
+ * {@link DynamicDrawTextArc} function. Defaults to {@link DynamicDrawTextCurve.FROWNY}.
+ *
+ * A drawing callback, used to add drawing effects to dynamic text.
+ * @callback DynamicDrawTextEffectFunction
+ * @param {string} text - The text to draw
+ * @param {CanvasRenderingContext2D} ctx - The canvas rendering context
+ * @param {number} x - The x coordinate at which the text should be drawn
+ * @param {number} y - The y coordinate at which the text should be drawn
+ * @param {DynamicDrawOptions} [options] - Additional drawing options
+ *
+ * A definition object that wraps the drawing functions that define a dynamic text effect
+ * @typedef DynamicDrawTextEffectDefinition
+ * @type {object}
+ * @property {DynamicDrawTextEffectFunction} [before] - A drawing callback that is called before the dynamic text is drawn
+ * @property {DynamicDrawTextEffectFunction} [after] - A drawing callback that is called after the dynamic text is drawn
+ *
+ * @see {@link DynamicDrawText} - for drawing basic horizontal text.
+ * @see {@link DynamicDrawTextFromTo} - for drawing text in a straight line between any given two coordinates.
+ * @see {@link DynamicDrawTextArc} - for drawing text in a circular arc.
+ */
+/**
+ * A common regex that can be used to check whether a given string is permitted for dynamic drawing (the character limitations are primarily
+ * to restrict the use of control characters and unicode characters that would cause odd behavior).
+ * @type {RegExp}
+ */
+declare const DynamicDrawTextRegex: RegExp;
+/**
+ * A regex pattern that can be attached to HTML input elements to check for validity - matches the DynamicDrawTextRegex
+ * @type {string}
+ */
+declare const DynamicDrawTextInputPattern: string;
+/**
+ * An array of valid printable characters that are permitted for dynamic drawing (used internally for text measurement purposes)
+ * @type {string[]}
+ */
+declare const DynamicDrawValidTextCharacters: string[];
+/**
+ * A padding multiplier for text when drawn in an arc. The extra padding helps ensure that the bottoms of characters don't collide
+ * @type {number}
+ */
+declare const DynamicDrawTextArcPaddingRatio: number;
+/**
+ * Cache for font measurements. These are used to make text which is drawn in an arc look more natural by respecting the widths of
+ * characters in various fonts.
+ * @type {Record.<string, {
+ *     width: number,
+ *     weights: Record.<string, number>
+ * }>}
+ */
+declare const DynamicDrawFontMeasurements: Record<string, {
+    width: number;
+    weights: Record<string, number>;
+}>;
+/**
+ * An enum encapsulating the directions that circular text can be drawn in (clockwise and anticlockwise)
+ */
+type DynamicDrawTextDirection = number;
+declare namespace DynamicDrawTextDirection {
+    const CLOCKWISE: number;
+    const ANTICLOCKWISE: number;
+}
+/**
+ * An enum encapsulating the possible curve directions of circular text. Can be "SMILEY" (bottom of text on the outer arc) or "FROWNY"
+ * (bottom of text on the inner arc).
+ */
+type DynamicDrawTextCurve = number;
+declare namespace DynamicDrawTextCurve {
+    const SMILEY: number;
+    const FROWNY: number;
+}
+/**
+ * An enum encapsulating the available drawing effects that can be applied to dynamic text.
+ * @type {{ BURN: "burn" }}
+ */
+declare const DynamicDrawTextEffect: {
+    BURN: "burn";
+};
+/**
+ * The default options that are used for dynamic text drawing.
+ * @type {DynamicDrawOptions}
+ */
+declare const DynamicDrawTextDefaultOptions: DynamicDrawOptions;
+/**
+ * Dynamic text effect definitions. The definitions define the drawing effects that can be applied to dynamically drawn text.
+ * @type {Record.<DynamicDrawTextEffect, DynamicDrawTextEffectDefinition>}
+ */
+declare const DynamicDrawTextEffects: Record<DynamicDrawTextEffect, DynamicDrawTextEffectDefinition>;
+/**
+ * DynamicDraw.js
+ * --------------
+ * This file contains common utilities for dynamically drawing text onto assets.
+ *
+ * An options hash that can be used to customize dynamically drawn text. No options need be specified, and some options are only applicable
+ * to certain drawing functions.
+ */
+type DynamicDrawOptions = {
+    /**
+     * - The target font size. Note that if space is constrained, the actual drawn font size will be reduced
+     * automatically to fit. Defaults to 30px.
+     */
+    fontSize?: number;
+    /**
+     * - The desired font family to draw text in. This can be a single font name, or a full CSS font stack
+     * (e.g. "'Helvetica', 'Arial', sans-serif"). Defaults to the player's chosen global font.
+     */
+    fontFamily?: string;
+    /**
+     * - The text alignment to use. Can be any valid
+     * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/text-align text alignment}. Not applicable to the {@link DynamicDrawTextArc }function. Defaults to "center".
+     */
+    textAlign?: CanvasTextAlign;
+    /**
+     * - The text baseline to use. Can be any valid
+     * {@link https://developer.mozilla.org/en-us/docs/Web/CSS/vertical-align vertical alignment}. Defaults to "middle".
+     */
+    textBaseline?: CanvasTextBaseline;
+    /**
+     * - The color that the text should be drawn in. Can be any valid CSS color string. Defaults to "#000".
+     */
+    color?: string;
+    /**
+     * - The stroke color that should be used for the text. Can be any valid CSS color
+     * string. Defaults to the same value as the `color` property.
+     */
+    strokeColor?: string;
+    /**
+     * - The stroke width that should be used when stroking the text. Only used if a `strokeColor` is defined. Defaults to 1.
+     */
+    strokeWidth?: number;
+    /**
+     * - A dynamic text effect to apply. No effects are applied by default.
+     */
+    effect?: DynamicDrawTextEffect;
+    /**
+     * - The maximum width of the drawn text. Not applicable to the {@link DynamicDrawTextFromTo } function, as
+     * constraints are defined by the endpoints. When defined for the {@link DynamicDrawTextArc } function, it defines the maximum width of the
+     * text perpendicular to the radius line on which the text is centered. Unlimited by default.
+     */
+    width?: number;
+    /**
+     * - Whether or not the text should be fully contained in the box defined by the from/to coordinates. Only
+     * applicable to the {@link DynamicDrawTextFromTo } function. Defaults to true.
+     */
+    contain?: boolean;
+    /**
+     * - The angle at which the text should be drawn, relative to the center of the circle. Angles are measured
+     * clockwise in radians starting at the vertical 12 o'clock position. For example 0 corresponds to 12 o'clock, PI/2 corresponds to
+     * 3 o'clock, PI corresponds to 6 o'clock, and 3PI/2 corresponds to 9 o'clock. Only applicable to the {@link DynamicDrawTextArc } function.
+     * Defaults to 0.
+     */
+    angle?: number;
+    /**
+     * - The radius in pixels of the circle whose arc the text should be drawn along. A smaller radius will result
+     * in a greater text curvature and vice versa. Only applicable to the {@link DynamicDrawTextArc } function. Defaults to 450px.
+     */
+    radius?: number;
+    /**
+     * - The maximum angle that the text should be drawn along. This effectively determines the maximum length of
+     * the arc along which the text will be drawn. Only applicable to the {@link DynamicDrawTextArc } function. Defaults to PI (a semicircle).
+     */
+    maxAngle?: number;
+    /**
+     * - The direction the text should be drawn in along the circular arc. Only applicable to
+     * the {@link DynamicDrawTextArc } function. Defaults to {@link DynamicDrawTextDirection.CLOCKWISE };
+     */
+    direction?: DynamicDrawTextDirection;
+    /**
+     * - The direction of the curve of the text. This determines whether the center of the text
+     * curves upwards ({@link DynamicDrawTextCurve.SMILEY }) or downwards ({@link DynamicDrawTextCurve.FROWNY }). Only applicable to the
+     * {@link DynamicDrawTextArc } function. Defaults to {@link DynamicDrawTextCurve.FROWNY }.
+     *
+     * A drawing callback, used to add drawing effects to dynamic text.
+     */
+    textCurve?: DynamicDrawTextCurve;
+};
+/**
+ * DynamicDraw.js
+ * --------------
+ * This file contains common utilities for dynamically drawing text onto assets.
+ *
+ * An options hash that can be used to customize dynamically drawn text. No options need be specified, and some options are only applicable
+ * to certain drawing functions.
+ */
+type DynamicDrawTextEffectFunction = (text: string, ctx: CanvasRenderingContext2D, x: number, y: number, options?: DynamicDrawOptions) => any;
+/**
+ * DynamicDraw.js
+ * --------------
+ * This file contains common utilities for dynamically drawing text onto assets.
+ *
+ * An options hash that can be used to customize dynamically drawn text. No options need be specified, and some options are only applicable
+ * to certain drawing functions.
+ */
+type DynamicDrawTextEffectDefinition = {
+    /**
+     * - A drawing callback that is called before the dynamic text is drawn
+     */
+    before?: DynamicDrawTextEffectFunction;
+    /**
+     * - A drawing callback that is called after the dynamic text is drawn
+     */
+    after?: DynamicDrawTextEffectFunction;
+};

package/bc/Scripts/Element.d.ts

@@ -0,0 +1,154 @@
+/**
+ * Handles the value of a HTML element. It sets the value of the element when the Value parameter is provided or it returns the value when the parameter is omitted
+ * @param {string} ID - The id of the element for which we want to get/set the value.
+ * @param {string} [Value] - The value to give to the element (if applicable)
+ * @returns {string} - The value of the element (When no value parameter was passed to the function)
+ */
+declare function ElementValue(ID: string, Value?: string): string;
+/**
+ * Handles the content of a HTML element. It sets the content of the element when the Content parameter is provided or it returns the value when the parameter is omitted
+ * @param {string} ID - The id of the element for which we want to get/set the value.
+ * @param {string} [Content] - The content/inner HTML to give to the element (if applicable)
+ * @returns {string} - The content of the element (When no Content parameter was passed to the function)
+ */
+declare function ElementContent(ID: string, Content?: string): string;
+/**
+ * Creates a new text area element in the main document. Does not create a new element if there is already an existing one with the same ID
+ * @param {string} ID - The id of the text area to create.
+ * @returns {void} - Nothing
+ */
+declare function ElementCreateTextArea(ID: string): void;
+/**
+ * Creates a new text input element in the main document.Does not create a new element if there is already an existing one with the same ID
+ * @param {string} ID - The id of the input tag to create.
+ * @param {string} Type - Type of the input tag to create.
+ * @param {string} Value - Value of the input tag to create.
+ * @param {string | number} [MaxLength] - Maximum input tag of the input to create.
+ * @returns {HTMLInputElement} - The created HTML input element
+ */
+declare function ElementCreateInput(ID: string, Type: string, Value: string, MaxLength?: string | number): HTMLInputElement;
+/**
+ * Creates a new range input element in the main document. Does not create a new element if there is already an
+ * existing one with the same id
+ * @param {string} id - The id of the input tag to create
+ * @param {number} value - The initial value of the input
+ * @param {number} min - The minimum value of the input
+ * @param {number} max - The maximum value of the input
+ * @param {number} step - The increment size of the input
+ * @param {ThumbIcon} [thumbIcon] - The icon to use for the range input's "thumb" (handle). If not set, the slider will
+ * have a default appearance with no custom thumb.
+ * @param {boolean} [vertical] - Whether this range input is a vertical slider (defaults to false)
+ * @returns {HTMLInputElement} - The created HTML input element
+ */
+declare function ElementCreateRangeInput(id: string, value: number, min: number, max: number, step: number, thumbIcon?: ThumbIcon, vertical?: boolean): HTMLInputElement;
+/**
+ * Creates a dropdown element and adjusts it to the BC look and feel. In the HTML Code this will look like this:
+ * <div> -- enclosing div used for css and postioning
+ *     <select> -- the select statement with its options
+ *         <option 1>
+ *         <option n>
+ *     </select>
+ *     <div></div> -- the div representing the currently selected item
+ *     <div> -- div for the various options
+ *        <div>Option 1</div>
+ *        <div>Option n</div>
+ *     </div>
+ * </div>
+ * This construct is built automatically and ignores the original select statement. All the logic is handled by
+ * event handlers that are connected to the various divs. See comments in the code.
+ * What this function cannot handle at the moment:
+ * - The size is always set to 1
+ * - Multiple selects are impossible
+ * @param {string} ID - The name of the select item. The outer div will get this name, for positioning. The select
+ * tag will get the name ID+"-select"
+ * @param {readonly string[]} Options - The list of options for the current select statement
+ * @param {EventListenerOrEventListenerObject} [ClickEventListener=null] - An event listener to be called, when the value of the drop down box changes
+ * @returns {void} - Nothing
+ */
+declare function ElementCreateDropdown(ID: string, Options: readonly string[], ClickEventListener?: EventListenerOrEventListenerObject): void;
+/**
+ * Closes all select boxes in the current document, except the current select box
+ * @param {object} elmnt - The select box to exclude from the closing
+ * @returns {void} - Nothing
+ */
+declare function ElementCloseAllSelect(elmnt: object): void;
+/**
+ * Creates a new div element in the main document. Does not create a new element if there is already an existing one with the same ID
+ * @param {string} ID - The id of the div tag to create.
+ * @returns {void} - Nothing
+ */
+declare function ElementCreateDiv(ID: string): void;
+/**
+ * Removes an element from the main document
+ * @param {string} ID - The id of the tag to remove from the document.
+ * @returns {void} - Nothing
+ */
+declare function ElementRemove(ID: string): void;
+/**
+ * Draws an existing HTML element at a specific position within the document. The element is "centered" on the given coordinates by dividing its height and width by two.
+ * @param {string} ElementID - The id of the input tag to (re-)position.
+ * @param {number} X - Center point of the element on the X axis.
+ * @param {number} Y - Center point of the element on the Y axis.
+ * @param {number} W - Width of the element.
+ * @param {number} [H] - Height of the element.
+ * @returns {void} - Nothing
+ */
+declare function ElementPosition(ElementID: string, X: number, Y: number, W: number, H?: number): void;
+/**
+ * Draws an existing HTML element at a specific position within the document. The element will not be centered on its given coordinates unlike the ElementPosition function.
+ * @param {string} ElementID - The id of the input tag to (re-)position.
+ * @param {number} Font - The size of the font to use.
+ * @param {number} X - Starting point of the element on the X axis.
+ * @param {number} Y - Starting point of the element on the Y axis.
+ * @param {number} W - Width of the element.
+ * @param {number} H - Height of the element.
+ * @returns {void} - Nothing
+ */
+declare function ElementPositionFix(ElementID: string, Font: number, X: number, Y: number, W: number, H: number): void;
+/**
+ * Sets a custom data-attribute to a specified value on a specified element
+ * @param {string} ID - The id of the element to create/set the data attribute of.
+ * @param {string} Name - Name of the data attribute. ("data-" will be automatically appended to it.)
+ * @param {string} Value - Value to give to the attribute.
+ * @returns {void} - Nothing
+ */
+declare function ElementSetDataAttribute(ID: string, Name: string, Value: string): void;
+/**
+ * Sets an attribute to a specified value on a specified element
+ * @param {string} ID - The id of the element to create/set the data attribute of.
+ * @param {string} Name - Name of the attribute.
+ * @param {string} Value - Value to give to the attribute.
+ * @returns {void} - Nothing
+ */
+declare function ElementSetAttribute(ID: string, Name: string, Value: string): void;
+/**
+ * Scrolls to the end of a specified element
+ * @param {string} ID - The id of the element to scroll down to the bottom of.
+ * @returns {void} - Nothing
+ */
+declare function ElementScrollToEnd(ID: string): void;
+/**
+ * Returns the given element's scroll position as a percentage, with the top of the element being close to 0 depending on scroll bar size, and the bottom being around 1.
+ * To clarify, this is the position of the bottom edge of the scroll bar.
+ * @param {string} ID - The id of the element to find the scroll percentage of.
+ * @returns {(number|null)} - A float representing the scroll percentage.
+ */
+declare function ElementGetScrollPercentage(ID: string): (number | null);
+/**
+ * Checks if a given HTML element is scrolled to the very bottom.
+ * @param {string} ID - The id of the element to check for scroll height.
+ * @returns {boolean} - Returns TRUE if the specified element is scrolled to the very bottom
+ */
+declare function ElementIsScrolledToEnd(ID: string): boolean;
+/**
+ * Gives focus to a specified existing element for non-mobile users.
+ * @param {string} ID - The id of the element to give focus to.
+ * @returns {void} - Nothing
+ */
+declare function ElementFocus(ID: string): void;
+/**
+ * Toggles HTML elements that were created by a given screen. When toggled off, they are hidden (not removed)
+ * @param {string} Screen - Screen for which to hide the elements generated
+ * @param {boolean} ShouldDisplay - TRUE if we are toggling on the elements, FALSE if we are hiding them.
+ */
+declare function ElementToggleGeneratedElements(Screen: string, ShouldDisplay: boolean): void;