PropInputSetting is used to modify your quick/animation properties to fit what you need.
However, it can be very confusing knowing what can be set, especially the PropDefs, args, and attributes of PropInputSetting.
PropDefs / fields
These are the fields in PropInputSetting, some of them are also made into PropDefs.
|PropDefs / fields
|The key of the PropDef which this PropInputSetting is tied to.
|Label of the property which appears in the properties box.
|Vessels that have tags intersecting with this set will get propertyChange() when this prop is modified.
|Sets the lockability of this property in the properties box.
|The visibility of this property in the properties box when it's built.
|This is used to determine whether a double type is converted to distance type
|A collection of str->Object map. Below this article are the list of arguments.
|Attributes are used to determine importability (which props are used by which animations).
|This is a way to create your own property instead of one of the defaults.
|Used to group properties together.
All properties of a group will be seperated from other groups.
|The index of the property within it's group. Not required. Indexed properties always come before those without an index in the same group.
|Overrides the Control Panel Setting for showing the measure button in distance fields.
Here is the list of arguments you can place in the args map.
|Updates the bound of the object after the value is changed.
|Updates the graphics of the object after the value is changed.
|Updates only the 2D graphics after the value is changed.
|Updates only the 3D graphics after the value is changed.
|Updates the parts after the value is changed.
|Re-selects the object after the value is changed.
|All of the above.
Snapper’s movement as the related
Connectors are stretched.
Connectors when the property is changed.
|The orientation of
Connector for property stretch in
|Sets the UI elements to a button for each entry in the domain.
|Sets the UI elements to a dropdown containing an entry for each element in the domain.
|Sets the UI elements to an entry box.
|Sets the UI elements to a slider bar of values.
|Sets the UI elements to a single button.
|Sets the UI elements into a greyed-out text, unable to be modified.
|str that is required to change to a
ButtonPropertyFactory, the string is shown on the generated button.
|Sets the field in the case of a double to a distance. Set by default for
PropDefs involving prop.
Overrides the control panel setting for showing the measure button in the distance field.
In the case of a distance field, allows for more precise values to be used.
|Displays only in 2D View.
|Displays only in 3D View.
|Defaulted class option for a
|Ignores the class of the prop on the construction of the
PropInputSetting relying instead on “type” to default to.
|The type to set the
PropInputSetting to in case of
ignoreClass being used.
|Property value is retained in the world.
|The value will remain in core settings.
|Changes to this prop will not be recorded by undo automatically.
Here is the list of arguments you can place in attributes set.
|Allows stretching for a double or distance type variable.
|Allows a rotation for an angle type variable. It may not be working, unclear at this time.
|Property is active during drag.
|Property is active during insert.
|Property is active while
PropObj is selected in space.
|Property is active during the stretch of ANOTHER property.
|Removes from all lists to be shown.
|Used to detect properties to propagate in
|Used in a conveyor abstract, rebuilds the property when changed.
|Used in abstract industry and plants. Forces a quick property to hide.
|Used in wardrobe abstract, hides the property from animation.
PropDef from being saved to a scheme.
PropScheme to denote this property as belonging to a scheme. This is deprecated
|Allows a push to this prop even if there is no domain. Will prevent null values from being pushed.
|Allows a push to this prop if the value is null.
|Prevents a prop from using a pipe during “get”.
|Exposable only by pipe.
|Exposable through proxy for read only access.
|Prevents a prop from using a pipe during “get”.
|Uses a put of this
PropDef when a copy of the
PropObj is used.
|Copies the value of this
PropDef when the parent object is copied.
|Does not copy the value of this
PropDef in any way when the object is copied.
PropDef’s value from being streamed.
|Animation Exclusive (Not Recommended for use, included only for article completeness)
|Used for the remover animation and vessels related to the remover tool. Removes all associated properties on
|Used only in k2 abstract, removes related properties during
userPropertyChanged() in the
|Used during a basepoint align animation to label properties.
|Used during select animation to add and remove core properties containing this attribute.
|Used during the
InspectorPickerAnimation to add and remove properties.
|Sym (In Testing)
|Allows a prop to be used as a
SymParams without explicitly calling
defineParam() is still necessary, unless
sym=true is set)
|Allows a prop to used as a
SymParams to ignore caching.
|Render UI Building (Included for article completeness, not recommended)
|Automatically included with any
PropDef that becomes a “property” of some sort.
PropDefs dealing with “Data” or “multidata”.
|Makes the factory lockable.