On this page

Scripter

The Scripter plugin

Constructor

new Scripter()

Source: src/Scripter.js, line 12

Members

containingAtom :Atom

The atom that contains this script

Type:

Atom

Source: src/Scripter.js, line 17

Methods

declareAction(name, callback) → {ActionDeclaration}

Parameters:

Name	Type	Description
`name`	string
`callback`	function

Source: src/Scripter.js, line 54

Returns:

Type:: ActionDeclaration

declareBoolParam(args) → {BoolParamDeclaration}

Parameters:

Name Type Description

args

Object

Properties

Name	Type	Attributes	Default	Description
`name`	string			The name of the JSON Storable Param
`default`	boolean	<optional>	false	The default value
`onChange`	function			Callback when the value changes

Source: src/Scripter.js, line 38

Returns:

Type:: BoolParamDeclaration

declareFloatParam(args) → {FloatParamDeclaration}

Parameters:

Name Type Description

args

Object

Properties

Name	Type	Attributes	Default	Description
`name`	string			The name of the JSON Storable Param
`default`	number	<optional>	0	The default value
`min`	number	<optional>	0	The minimum value
`max`	number	<optional>	1	The maximum value
`constrain`	boolean	<optional>	true	Whether the value can exceed the min/max settings
`onChange`	function			Callback when the value changes

Source: src/Scripter.js, line 29

Returns:

Type:: FloatParamDeclaration

declareStringParam(args) → {StringParamDeclaration}

Parameters:

Name Type Description

args

Object

Properties

Name	Type	Attributes	Default	Description
`name`	string			The name of the JSON Storable Param
`default`	string	<optional>	""	The default value
`onChange`	function			Callback when the value changes

Source: src/Scripter.js, line 47

Returns:

Type:: StringParamDeclaration

onFixedUpdate(fn) → {void}

Called every physics frame

Parameters:

Name	Type	Description
`fn`	function

Source: src/Scripter.js, line 68

Returns:

Type:: void

onUpdate(fn) → {void}

Called every frame

Parameters:

Name	Type	Description
`fn`	function

Source: src/Scripter.js, line 61

Returns:

Type:: void