The Property Builder is used to set up options on a Module for easier changes by a user of the Module. The main benefit being a user does not need to go into the LUA code and make changes for different functionality.

Options can be set to either send data into the Module, receive data from the Module, give information about the Module, or just activate Actions in the Module.

Example Module

The Property Builder can be called up by right-clicking on a Module. In this example, we use the “PropertiesExample” Module to show how the different functions are used.

This Module comes with the PIXERA installation, but if needed here is the download link: PropertiesExample.json:

To open the Property Builder, right-click on the Module and select: “Launch Property Builder”:

Overview

1. Name: Sets the name of the property, this is important for the assignment in the code and for the understanding of the user. Ideally, the name of the property is self-explanatory.
    
2. Value: Sets the default value of the property and in many cases can be defined by the user in real time. If read only is activated, this value can not be changed in the inspector.
    
3. Type Hint: Determines the Type of variable the Property is set as. This does not necessarily correspond to what can be read in the LUA code, for example number values are still used in LUA as string and so need converted.
    
4. Read Only: Defines whether the user can edit this property or not in the inspector.
    
5. Show Name: Specifies whether the name of the property is also visible to the user, or whether only the element itself is displayed. 
    
6. Group: Acts as a folder, properties with the same Group name will appear under a Folder named as the Group.
    
7. Options Source: Will run an inputted Action via the path to it entered. The format of the return inside the Action must be a one dimensional Table.

   1. In the example code of this Module, a table is generated from a map, to hide the values that are not useful for the user, behind a meaningful text, so a value can be stored for different options.

      

       

8. Options Action: Used to call Actions when an option for the property is selected/inputted. The selected input is also sent to the connected Action. The init function can also be specified here if a Module needs to be reinitialized after a change.
   1. The reading of the set value can also be done with the self.helper:getProperty("My Property") function from the helper, this can be done at any time.
       
9. Image: A file can be stored which is displayed as an image in the Inspector. Please note that this image is saved directly in the Module and can significantly increase the data size of the Module.

Creating Properties

1. New properties are added with this element, they will be added below the current selected element.
2. This element is used to delete properties.
3. This element changes the order of the selected element.
4. This element changes the order of the selected element.
5. The desired element can be selected in this area.

The “Auto Init” Action

This “Auto Init” Action has a special meaning, this property is included in almost all Modules and is executed from the C++ part of PIXERA when the LUA core is started (rebuilt). If this property is set to true, the Action of the Module with the name "init" is executed after any reload.
 

The “uninit” Action is always called when the LUA core gets closed or rebuild. This is a related to the name of the Action. The "uninit" Action is always called regardless of the "Auto Init" property.

PIXERA 2.0.108 | 17. June 2024 | J.B.