A script is a type of Asset where you can write Lua code. The code contained in your script can be anything from game logic to drawing code.

Once attached to the Handler of an existing resource; events associated with the resource will be triggered at runtime or during the drawing process.

In order for your scripts to respond to these events, your code should contain predefined functions that match the events triggered by the resource it is attached to. Refer to the resource help page to learn more about which event it respond to and what are the expected functions that should be implemented.

See Also

Asset, Handler, LvmThread, Utility

Static Variables

Name	Description
`asset`	Reference to the parent Asset where the Script is defined.
Declaration Asset *asset
`source`	Stream that contains the raw source code of the Script.
Declaration Stream source Note When publishing your project it is automatically stripped out of the final output. Only the binary code will be used.
`binary`	Binary Stream that contains the precompiled code of the Script.
Declaration Stream binary Note The binary data contained in the Stream is ready to be used by the virtual machine. At this stage, there is no need for extra parsing or other types of processing; the Script can be executed directly by the Lua Virtual Machine (Lvm).
`nodetree`	Reference to the NodeTree attached to the Script.
Declaration NodeTree *nodetree Remarks Nodes can be used during development time to facilitate the coding process. The NodeTree attached to the Script will strictly be used to generate the raw code that will be precompiled to binary code. When publishing your application all definition associated with the NodeTree will be discarded.
`breakpoint_count`	Total amount of Breakpoint currently associated to a line in the Script.
Declaration unsigned int breakpoint_count

Variables

Name	Description
`revision`	Current revision of the Script.
Declaration unsigned int revision Note Revision is automatically incremented each time the Script gets recompiled. Modifying this value manually will force the system to terminate the coroutine(s) the Script is associated with and reload the binary code.
`activate_breakpoints`	Control wheter or not Breakpoint should be enabled or disabled.
Declaration bool activate_breakpoints
`event_mask`	Bit mask created from the EventType cap detected in the Script.
Declaration int64_t event_mask

Functions

Name	Description
`GetBreakpoint`	Return the Breakpoint located on a specific line.
Declaration Breakpoint GetBreakpoint( unsigned int line ) Parameters `line`: Specify the line of the Breakpoint to return. Return Value On success a fully filled Breakpoint structure; upon failure the `line` number will be negative.
`AddBreakpoint`	Create a new Breakpoint.
Declaration bool AddBreakpoint( unsigned int line ) Parameters `line`: The line where the new Breakpoint should be placed. Return Value `true` if a new Breakpoint have been created; else return `false` if an existing Breakpoint is already placed at the `line` received in parameter.
`SetBreakpoint`	Specify if the Breakpoint at a specific line should be toggled on/off.
Declaration bool SetBreakpoint( unsigned int line, bool enabled ) Parameters `line`: Access the Breakpoint at a specific line. `enabled`: Specify if the Breakpoint should be enabled or not. Return Value `true` upon a successfull change; `false` if no Breakpoint exists at the line specified.
`RemoveBreakpoint`	Remove a Breakpoint located on a specific line.
Declaration bool RemoveBreakpoint( unsigned int line ) Parameters `line`: The line where the Breakpoint to remove is located. Return Value `true` if the Breakpoint has been removed; else return `false` if no Breakpoint resides at the `line` specified.
`UseNodes`	Toggle wheter or not the Script should be using a NodeTree.
Declaration NodeTree UseNodes( bool use_nodes ) Parameters* `use_nodes`: Specify wheter or not the Script should allocated a NodeTree to use for visual coding. Return Value Reference to the NodeTree associated to the active Script; else return `nil` if the Script does not use nodes.
`IsUsingNodes`	Helper that evaluates if a Script is using nodes or not.
Declaration bool IsUsingNodes( void ) Return Value `true` if a NodeTree is attached to the Script; else return `false`.
`Update`	Manually force the active Script to be updated.
Declaration void Update( void ) Remarks A manual update is basically only used when the Script is being debugged. Once the debugger breaks the execution of a Script the update function call will force the debugger to release the Script and cancel all existing errors (if any).
`Build`	Precompile the active Script by converting raw code to binary code ready to be executed by the virtual machine.
Declaration bool Build( void ) Return Value `true` on success; `false` if any error is encountered.

Breakpoint

A small structure that defines a breakpoint in a Script active code.

Static Variables

Name	Description
`line`	The line number where the Breakpoint is placed.
Declaration int line
`enabled`	Boolean value that represent if the Breakpoint is activated or not.
Declaration bool enabled

Variables

To expose a variable to the LvmThread responsible for handling the coroutine of the Script, all you have to do is to define a local variable outside of a function.

Once defined this variable value can then be manipulated the same way as member variables. It can be accessed and modified by another Script; Utility etc... Please refer to the LvmThread help page to learn how to access and modify existing local variables defined in a Script.