Script Class

Extends Object
Module: Script

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

These scripts can access everything inside of the program where they are running they should be used to control logic aspect of the application.

Its possible to extend these scripts by using libraries that can be imported using the include() function provided. Libraries can be stored locally on the project or loaded from remote sources.

Methods

appData

(
  • data
)

Call onAppData if available.

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

Parameters:

  • data Object

compileCode

(
  • code
  • onReady
)

Prepare the script code to be run. The script can be prepared using different methods depending on the include mode defined.

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

Parameters:

  • code String
  • onReady Function

    Funtion called when the code is ready.

dispose

()

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

Calls the script dispose method if it exists.

getIncludes

(
  • code
)
static

Get includes from the code.

Used to extract includes from code when loading libraries in APPEND mode.

Parameters:

  • code String

    Script code.

include

(
  • name
)

Auxiliar function to include javascript source file from resource into the script.

The imported source is evaluated and loaded in the context of the script.

Global declarations need to be cleaned using the dipose method.

Parameters:

  • name String

    Javascript resource name.

initialize

()

Initialize script. Automatically called by the runtime.

Compiles the script code and calls the script initialize method if it exists after the code is compiled.

removeIncludes

(
  • code
)
static

Remove includes from code.

Used to remove include statements when initializing code in APPEND mode.

Parameters:

  • code String

    Script code.

resize

()

Call resize method if available.

The resize method receives width and height as arguments.

update

()

Update script state.

Calls the script update method if it exists.

Properties

code

String

Javascript code attached to the script.

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(delta)
    • Called on every frame after rendering
  • dispose
    • Called when disposing the program
  • onMouseOver(intersections)
    • Called on every frame if mouse is on top of one of the script children
    • Receives an intersections array as argument.
  • onResize(x, y)
    • Called every time the window is resized
    • Receives width and height as parameters
  • onAppData(data)
    • 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

There is also access to the following functions

  • include
    • Include a javascript file from resources, when including files the user needs to be carefull and clear manually global declarations. The access to this method may be restricted depeding on the include mode

mode

Number

Mode indicates how to include external javascripts files into the script.

Can be APPEND, EVALUATE or INCLUDE.

APPEND mode with append the library code to the script code, when running in this mode the include method cannot be used during runtime

EVALUATE node with evaluate the library code during runtime, include method may still be used.

INCLUDE mode will include the file as a global script, these libraries are not unloaded after the script or application is terminated.

program

Program

Reference to the program object.

Can be used to access other scenes, get resources and objects.

scene

Scene

Reference to the scene where the script is placed.

Can be used to interact with other objects.

Attributes

APPEND

Number

Append libraries on initialization.

Libraries are appended to the script code on initialization.

DEFAULT

String

Default script code used when creating a new Script.

EVALUATE

Number

Evaluate libs during runtime.

This allows to load new libs during runtime, but its not possible to access private statements.

INCLUDE

Number

Include file into the document.body.

This imports the JS file as any other file included into a