Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ScriptValueProviderArguments

Arguments for the function of a script value.

Hierarchy

Index

Properties

Properties

emitGlobal

emitGlobal: function

Emits a global event.

param

The event.

param

The arguments.

Type declaration

    • (event: string | symbol, ...args: any[]): boolean

    • Parameters

      • event: string | symbol
      • Rest ...args: any[]

      Returns boolean

globalState

globalState: Object

Gets the object that can share data between all values.

globals

globals: GlobalVariables

The global variables from the settings.

name

name: string

Gets the name of that value.

options

options: any

Gets the data for the underlying script.

others

others: object

Gets the object that can access the other values.

Type declaration

  • [key: string]: any

replaceWithValues

replaceWithValues: function

Handles a value as string and replaces placeholders.

param

The value to parse.

returns

The parsed value.

Type declaration

    • (val: any): string

    • Parameters

      • val: any

      Returns string

require

require: function

Loads a module from the script context.

param

The ID / path to the module.

returns

The loaded module.

Type declaration

    • (id: string): any

    • Parameters

      • id: string

      Returns any

state

state: any

Gets or sets a state for that script.

Generated using TypeDoc