Skip to main content

Module values

Module values 

Source
Expand description

The values a program is run with from outside: what a program placing it sets its parameters to (Setting), and what its state holds (StateValue): where its placed parts are and how its joints are turned — what a solve moves, kept with the program between runs. Both are saved in a program file, so they are the file format’s, not an operation’s.

Enums§

Setting
What a parameter is set to where a program places the part: a number, or the name of a table’s row, or a colour. Saved as itself — 2.5, "M5", "#ff8800".
StateValue
A value of a part’s state: a number or a pose. Serialized as itself — 2.5, {"position": [...], "rotation": [...]}.

Functions§

pose_in
The pose a value holds, if it holds one: none for a number — what a pose state reads as before anything solved for it.
pose_state
The name of the state that is where the part placed as instance is: bolt.pose.

Type Aliases§

Settings
Parameter settings, by name: the inputs of a run.
StateValues
A part’s state, by name.