ClassLuaDisplayPanelControlBehaviorextendsLuaControlBehaviorchanged
| Inherits from LuaControlBehavior |
Members
| add_record(message, index?) new | → boolean | Adds a single message record. |
Adds a single message record. | ||
| remove_record(index) new | Removes message record at specified index. | |
Removes message record at specified index. | ||
| move_record(old_index, new_index) new | Moves record from old position to a new position | |
Moves record from old position to a new position | ||
| get_record(index) new | → DisplayPanelMessageDefinition | Get a single record. |
Get a single record. | ||
| set_record(index, record) new | Change content of a specific record. | |
Change content of a specific record. | ||
| max_records_count new | :: R uint32 | Provides a maximum amount of records that can be added to this behavior. [...] |
Provides a maximum amount of records that can be added to this behavior. [...] | ||
| records_count new | :: R uint32 | Current amount of records this control behavior has. |
Current amount of records this control behavior has. | ||
| records new | :: RW array[DisplayPanelMessageDefinition] | The full list of configured messages. |
The full list of configured messages. | ||
| valid | :: R boolean | Is this object valid? [...] |
Is this object valid? [...] | ||
| object_name | :: R string | The class name of this object. [...] |
The class name of this object. [...] | ||
| get_circuit_network(wire_connector_id) | → LuaCircuitNetwork? | |
| input_networks new | :: RW CircuitNetworkSelection? | Which circuit networks (red/green) to read signals from. [...] |
Which circuit networks (red/green) to read signals from. [...] | ||
| output_networks new | :: RW CircuitNetworkSelection? | Which circuit networks (red/green) to send signals to. [...] |
Which circuit networks (red/green) to send signals to. [...] | ||
| type | :: R defines.control_behavior.type | The concrete type of this control behavior. |
The concrete type of this control behavior. | ||
| entity | :: R LuaEntity | The entity this control behavior belongs to. |
The entity this control behavior belongs to. | ||
Methods
add_record(message, index?) → booleannew
Parameters
| message | :: DisplayPanelMessageDefinition | Message record to be added. |
Message record to be added. | ||
| index | :: uint32? | Index at which this record should be inserted. Must be within [1, records_count + 1]. When not provided, record will be appended. |
Index at which this record should be inserted. Must be within [1, records_count + 1]. When not provided, record will be appended. | ||
Return values
| → boolean | If a message record was added. |
remove_record(index)new
Parameters
| index | :: uint32 | Index of the message record to be removed. Must be within [1, records_count]. |
Index of the message record to be removed. Must be within [1, records_count]. | ||
move_record(old_index, new_index)new
get_record(index) → DisplayPanelMessageDefinitionnew
set_record(index, record)new
Parameters
| index | :: uint32 | Index of the record to change |
Index of the record to change | ||
| record | :: DisplayPanelMessageDefinition | |
