YOUR ACCOUNT

The Script Settings dialog (accessible via the Settings button below the script editing area on the Script tab in the properties of Map Script and Curve Script components) lets you modify flags and other settings for the currently selected script component. These settings are stored per component, not globally for all script components – for example, a filter can have two components with different flags.

Script Settings dialogScript Settings dialog

Flags

Flags allow you to adjust certain properties of the script component that affect the way the component and the filter containing it are handled by the Filter Forge GUI and rendering infrastructure. Additionally, component's flags affect the availability of certain scripting features to its Lua script.

Can output HDR colors

When this flag is turned on, the component is marked as being able to output HDR colors. When this flag is turned off, the RGB channels of colors returned by component's get_sample() function will be automatically clipped into the 0…1 range.

This flag is available for Map Script components only, it is disabled for Curve Script components.

Makes use of the global Size setting

When this flag is turned on, the component notifies the Filter Forge GUI that the global Size slider in Filter Controls should be enabled. Additionally, the rendering infrastructure is notified that the component should be invalidated and recalculated when the Size value is changed.

Script components that have this flag turned on can access the value of the Size slider via the SIZE variable – when the flag is turned off, Filter Forge does not expose this variable to Lua scripts. For more information on API variables, see Scripting API.

Makes use of the global Variation setting

When this flag is turned on, the component notifies the Filter Forge GUI that the global Variation slider in Filter Controls should be enabled. Additionally, the rendering infrastructure is notified that the component should be invalidated and recalculated when the Variation value is changed.

Script components that have this flag turned on can access the value of the Variation slider via the VARIATION variable – when the flag is turned off, Filter Forge does not expose this variable to Lua scripts. For more information on API variables, see Scripting API.

Produces patterns with discrete tiling

When this flag is turned on, the script component is marked as a discrete component, thus turning the filter containing it into a Discrete Filter.

This flag is available for Map Script components only, it is disabled for Curve Script components.

Produces seamlessly-tiled results

When this flag is turned on, the script component is marked as seamlessly-tiled. By default, this flag is turned off, so script components are considered to be Non-Seamless Components.

When this flag is turned on, the Filter Forge GUI takes this component into account when it decides whether the Seamless Tiling checkbox should be enabled, and the rendering infrastructure is notified that this component should be invalidated and recalculates when the Seamless Tiling setting is changed.

Script components that have this flag turned on can access the state of the Seamless Tiling setting via the SEAMLESS variable and the width and height of the seamless region (i.e. the region in which the component must maintain seamless tiling when Seamless Tiling is turned on) via the SEAMLESS_REGION_WIDTH and SEAMLESS_REGION_HEIGHT variables. For more information on API variables, see Scripting API.

This flag is available for Map Script components only, it is disabled for Curve Script components.

Script Safety

There is only one setting within this group, the Unsafe Script checkbox. When checked, it allows the script component to execute Unsafe Scripts, provided that execution of unsafe scripts is enabled in Tools > Options > Scripts. Unsafe scripts have unrestricted access to all Lua functions. For more information on availability of standard Lua functions to scripts, see Scripting API.