API Docs for:
Show:

LS.Components.Script Class

Defined in: ../src/components/script.js:2
Module: LS

Script must be coded in Javascript and they have full access to all the engine, so one script could replace the behaviour of any part of the engine. Scripts are executed inside their own context, the context is local to the script so any variable defined in the context that is not attached to the context wont be accessible from other parts of the engine. To interact with the engine Scripts must bind callback to events so the callbacks will be called when those events are triggered, however, there are some generic methods that will be called

Constructor

LS.Components.Script

(
  • object
)

Defined in ../src/components/script.js:2

Parameters:

  • object Object

    to configure from

Methods

getActions

()

Defined in ../src/components/script.js:374

get actions that could be performed from graphs or animations

getEvents

()

Defined in ../src/components/script.js:391

get events that could be triggered by this component

hasBreakpoint

(
  • method_name
)
Boolean

Defined in ../src/components/script.js:222

tells if there is a breakpoint set (using addBreakpoint) in this method

Parameters:

  • method_name String

    name of the method to check if it has a breakpoint

Returns:

Boolean:

true if there is a breakpoint

hookEvents

()

Defined in ../src/components/script.js:516

This check if the context binds engine events to the methods in the context with an specific name. This way we dont have to bind manually all the methods.

onScriptEvent

()

Defined in ../src/components/script.js:561

Called every time an event should be redirected to one function in the script context

processCode

()

Defined in ../src/components/script.js:236

This is the method in charge of compiling the code and executing the constructor, which also creates the context. It is called everytime the code is modified, that implies that the context is created when the component is configured.

reload

()

Defined in ../src/components/script.js:189

Force to reevaluate the code (only for special situations)

reload

(
  • [on_complete=null]
)

Defined in ../src/components/script.js:879

Force to reevaluate the code (only for special situations like remove codes)

Parameters:

  • [on_complete=null] Function optional

setBreakpoint

(
  • method_name
  • value
)

Defined in ../src/components/script.js:198

It will stop the execution when this method is called, but only if the console is open and the method is an event related method (onRender, onUpdate, etc)

Parameters:

  • method_name String

    name of the method to add breakpoint

  • value Boolean

    true to set, false to remove