Param() function

The @Param decorator can be used on script properties to show them in the property panel of the script on the studio. if no type defined the engine will try to guess the type from it's default value. some Params need to be initialized, please refer to their documentation page

Signature:

export declare function Param(options?: ScriptParam): any;

Parameters

Parameter

Type

Description

options

ScriptParam

(Optional)

**Returns:**

any

td>

Animation(opts)

static

Animation()

static

Array(init, opts)

static

Array(itemType, opts)

static

Boolean(def, opts)

static

Boolean(opts)

static

Boolean()

static

Color(def, opts)

static

Color(opts)

static

Color()

static

Component(of)

static

Component(of)

static

Component(of)

static

Folder(label, t)

static

Map(itemType, opts)

static

Number(def, opts)

static

Number(opts)

static

Number()

static

Object(instanceOrClass, opts)

static

Resource(of)

static

Secret(opts)

static

Select(options, opts)

static

Select(options, def, opts)

static

Select(opts)

static

Signal(type, opts)

static

Signal(opts)

static

String(def, opts)

static

String(opts)

static

String()

static

Trigger(action, opts)

static

Trigger(opts)

static

Union(options, opts)

static

Vector2(x, y, opts)

static

Vector2(def, opts)

static

Vector2(opts)

static

Vector2()

static

Vector3(x, y, z, opts)

static

Vector3(def, opts)

static

Vector3(opts)

static

Vector3()

static