[Rseding91][0.14.21] LuaConstantCombinatorControlBehavior Documentation mismatch / Duplicate Field.

[nullvoid]

In the documentation for LuaConstantCombinatorControlBehavior, it claims that the (R/W) parameters field is a single ConstantCombinatorParameters, which is itself an array of tables.

However, it turns out that the parameters field is a table with a single field ALSO called "parameters", which has type ConstantCombinatorParameters.

The following is an excerpt from a mod I am creating, which demonstrates the issue.

Code: Select all

local b = combinator.get_or_create_control_behavior()
newParams = <...> // :: ConstantCombinatorParameters (as per docs, an array of {signal, count, index} )

b.parameters = {parameters = newParams}      // <-- This line

What I would expect is for the last line to read

Code: Select all

 b.parameters = newParams 

[justarandomgeek]

This gets talked about on IRC pretty much everytime someone starts playing with scripting circuits - My understanding is that it's a result of the underlying architecture (and relates to how these things are blueprinted, I beleive), and would be non-trivial to change.

[Rseding91]

This gets talked about on IRC pretty much everytime someone starts playing with scripting circuits - My understanding is that it's a result of the underlying architecture (and relates to how these things are blueprinted, I beleive), and would be non-trivial to change.

Correct. It's so the data you get from a blueprint about a constant combinatory is the same data you use to create the entity with those values and is the same as you set them directly on a real entity.

[nullvoid]

Ok, Fair enough.

Will the Documentation be changed to reflect this?