Script Class

Extends Object
Module: Script

Script objects are used to control other objects present in the scene.

It can access and change every object in the program and supports some events

  • initialize
    • Called on app initialization, its called after all children elements are initialized, its safe to apply operations on other objects inside this method.
  • update
    • Called on every frame after rendering
  • dispose
    • Called when disposing the program
  • onMouseOver
    • Called on every frame if mouse is on top of one of the script children
  • onResize
    • Called every time the window is resized
  • onAppData
    • Called when receiving data sent by the host website

Code written inside scripts have access to the following attributes:

  • scene
  • program
  • self
    • Same as this reference but global in the script scope
  • Keyboard
  • Mouse

Methods

appData

(
  • data
)

Call onAppData if available.

Called automatically every time external data is passed to the runtime.

Parameters:

  • data Object

dispose

()

Disposes the script, can be used to clear resources when the program exits.

Calls the script dispose method if it exists.

initialize

()

Initialize script Automatically called by the runtime Calls the script initialize method if it exists

resize

()

Call resize method if available.

Called automatically by the runtime.

setCode

(
  • code
)

Set script code.

Can be used to dinamically change the script code. However it is not recommended can lead to undefined behavior.

Parameters:

  • code String

toJSON

(
  • meta
)
Object

Create JSON for script.

Parameters:

  • meta Object

Returns:

Object:

json

update

()

Update script state.

Calls the script update method if it exists.

Properties

code

String

Javascript code attached to the script

program

Program

Pointer to the parent program Used access program resources easier

scene

Scene

Pointer to the parent scene

Attributes

DEFAULT

String

Default script code used when creating a new Script.

METHODS

Array

List of methods that a script can implement.

script

Function

Compiled function used during runtime