The PIXERA Code Editor provides a comprehensive set of predefined autocomplete entries and reusable code snippets. These elements can be inserted via the auto-completion mechanism to accelerate script development, reduce syntax errors, and support the discovery of new API calls.

This article documents the available calls in alphabetical order and describes their respective functionalities.

A

• and
  • Used inside if statements for extending a conditional to include multiple checks.
     
• asyncCall()
  • The Utils.Timer.asyncCall Utlity Call allows you to run an Action with asynchronously from the rest of the running Module.

B

• break
  • Used to break out of a Loop early.

C

• Cue.getInst()
  • The Pixera.Timelines.Cue.getInst() API Call to get the Instance of a Cue.

E

• else
  • Used with if statements to run the code inside if all other if and elseif conditions have failed.
     
• elseif
  • Used with if statements to run the code inside if the previous if or elseif condition failed, and the given condition is true.
     
• end
  • Concludes the end of a variety of statements in LUA, such as the end of an if statement, a function, or a loop.

F

• for
  • Creates a For Loop to run the code inside continuously until the condition is met.
     
• for pairs
  • Creates a For Pair Loop used to grab every element in a given table for running further commands on each.
     
• for pairs … print
  • Creates a For Pair Loop used to grab every element in a given table to then print the i Variable alongside the value inside the table at the index of i.
     
• function
  • Creates an empty Function Statement, its Arguments and code are then needed to give it functionality.

I

• if
  • Creates an if statement to run the code inside if the condition is met.
     
• if else
  • Creates an if statement to run the code inside if the condition is met. An else statement is also created to run the code inside if the if statement fails.
     
• if NOT
  • Creates an if statement with a not conditional, running the code inside if the main condition is not met.
     
• interval
  • Creates a line of code to set an Interval. An Interval is a timer which will continuously run an Action every set amount of milliseconds.
  • Interval-triggered actions/code 
     
• io
  • Opens the window to all the functions that can be used under the Input/Output LUA Library inside PIXERA, with descriptions on their usage.
     
• InternalScripting
  • Opens the window to multiple internal API calls involving the RX and GUI Engines of PIXERA. It also contains some Utility Calls.

L

• local
  • Used to specify a following variable as a local variable, meaning it will be cleared from memory once the Action has finished.
     
• local function
  • Creates a local function statement to then fill in the name, variables, and inside code.
     
• logDump
  • Snippet to quickly log and Dump.
     
• Layer.getInst()
  • Creates the API Call path to get the instance of a Layer.
     
• LiveSystem.getInst()
  • Creates the API Call path to get the instance of a LiveSystem.

M

• math
  • Gives visual to all the functions that can be used under the Math LUA Library inside Pixera with descriptions on their usage.

N

• Node.getInst()
  • Creates the API Call path to get the instance of a Node.

O

• os
  • Gives visual to all the functions that can be used under the OS LUA Library inside Pixera with descriptions on their usage.

P

• pcall()
  • Creates a Try-Catch statement for the user to then enter the function to test and its arguments, with the results returning to two separate variables.
     
• pcall if not success
  • Creates a Try-Catch statement for the user to then enter the function to test and its arguments, with the results returning to two separate variables. Another statement is also created which will run the code inside if the “success” variable is false.
     
• pcall if success
  • Creates a Try-Catch statement for the user to then enter the function to test and its arguments, with the results returning to two separate variables. Another statement is also created which will run the code inside if the “success” variable is true.
     
• pixc
  • Gives visual to all Logging and Node calls.
     
• print()
  • Will call the similar pixc.log call to print the given data into the log.
     
• Param.getInst()
  • Creates the API Call path to get the instance of a Parameter.
     
• Projector.getInst()
  • Creates the API Call path to get the instance of a Projector.
     
• Pixera
  • Gives visual to all the main API Calls found in the PIXERA Module and the PIXERA Direct API.

R

• require “json”
  • Allows the internal JSON library to be used. Will create a statement creating a “self.json” variable which needs to be used for the calls.
     
• require “pixcHelper”
  • Allows the internal Helper library to be used. Will create a statement creating a “self.helper” variable which needs to be used for the calls.
     
• require “xml2lua”
  • Allows the internal XML library to be used. Will create a statement creating a “self.xml2lua” variable which needs to be used for the calls.
     
• require “xmlhandler.tree”
  • Allows the internal XML Handler library to be used. Will create a statement creating a “self.treehandler” variable which needs to be used for the calls.|
     
• return
  • Will end the running of the Action when used, will also return any following variables to an Action if it had called this one.
     
• Resource.getInst()
  • Creates the API Call path to get the instance of a Resource.
     
• ResourceFolder.getInst()
  • Creates the API Call path to get the instance of a ResourceFolder.

S

• setPosition()
  • Sets the Position of a WEB UI Element on this Module from the given Page, Element name, and position values.
     
• setStyle()
  • Sets the Style of a WEB UI Element on this Module from the given Page, Element name, and Style name.
     
• setValue()
  • Sets the value of a WEB UI Element on this Module from the given Page, Element name, and value.
     
• setVisible()
  • Sets the Visibility of a WEB UI Element on this Module from the given Page, Element name, and boolean value.
     
• self()
  • Gives visual to all the Actions that can be called on this Module, including the Utility Actions. Can also create Variables on the Module with this call.
     
• setTimeout()
  • Creates an async call statement which will call the function with the inside code after the specified amount of milliseconds.
     
• sleep()
  • Creates a sleep statement to pause the running of the Action code for the specified milliseconds.
     
• string
  • Gives visual to all the functions that can be used under the String LUA Library inside Pixera with descriptions on their usage.
     
• Screen.getInst()
  • Creates the API Call path to get the instance of a Screen.

T

• table
  • Gives visual to all the functions that can be used under the Table LUA Library inside Pixera with descriptions on their usage.
     
• tonumber()
  • Creates a statement to turn the given value into a number value.
     
• tostring()
  • Creates a statement to turn the given value into a string value.
     
• type()
  • Creates a statement to check the given value's type and return a string of that type's name.
     
• Timeline.getInst()
  • Creates the API Call path to get the instance of a Timeline.

W

• while … end
  • Creates a while loop to run the inside code until the given condition is failed.
     
• wait()
  • Creates a sleep statement to pause the running of the Action code for the specified milliseconds.

Pixera 2.0.172 | 12. November 2024 | C.L.