PropInputSetting Args and Attributes

Arguments

Modify
modifyBound	Updates the bound of the object after the value is changed.
modifyVis	Updates the graphics of the object after the value is changed.
modify2D	Updates only the 2D graphics after the value is changed.
modify3D	Updates only the 3D graphics after the value is changed.
modifyParts	Updates the parts after the value is changed.
modifySelect	Re-selects the object after the value is changed.
modifyAll	All of the above.

Connector
disableMoveReq	Disables the `Snapper`’s movement as the related `Connector`s are stretched.
disconnectAll	Disconnects all `Connector`s when the property is changed.
connectorOrientation	The orientation of `Connector` for property stretch in `Space`.

UI Behavior
buttons	Sets the UI elements to a button for each entry in the domain.
list	Sets the UI elements to a dropdown containing an entry for each element in the domain.
input	Sets the UI elements to an entry box.
slider	Sets the UI elements to a slider bar of values.
button	Sets the UI elements to a single button.
btnLabel	str that is required to change to a `ButtonPropertyFactory`, the string is shown on the generated button.
distanceField	Sets the field in the case of a double to a distance. Set by default for `PropDef`s involving prop.
useDistanceMeasure	Overrides the control panel setting for showing the measure button in the distance field.
allowPrecise	In the case of a distance field, allows for more precise values to be used.

Class
class	Defaulted class option for a `PropInputSetting`.
ignoreClass	Ignores the class of the prop on the construction of the `PropInputSetting` relying instead on “type” to default to.
type	The type to set the `PropInputSetting` to in case of `ignoreClass` being used.

Persistence
persistent	Property value is retained in the world.
persistentOnCoreSettings	The value will remain in core settings.

Undo
ignoreUndo	Changes to this prop will not be recorded by undo automatically.

Animation
#stretch	Allows stretching for a double or distance type variable.
#rotate	Allows a rotation for an angle type variable. It may not be working, unclear at this time.
#drag	Property is active during drag.
#insert	Property is active during insert.
#quick	Property is active while `PropObj` is selected in space.
#internal	Property is active during the stretch of ANOTHER property.
#hide	Removes from all lists to be shown.
#propertyPropogate	Used to detect properties to propagate in `propogatePropertyAnimation()`.

Abstract Exclusive
#remakeAtChange	Used in a conveyor abstract, rebuilds the property when changed.
#hideQuickProp	Used in abstract industry and plants. Forces a quick property to hide.
#hideAnimationProp	Used in wardrobe abstract, hides the property from animation.

Scheme
#hideScheme	Stops a `PropDef` from being saved to a scheme.
#scheme	Used in `PropScheme` to denote this property as belonging to a scheme. This is deprecated

Push
#allowPush	Allows a push to this prop even if there is no domain. Will prevent null values from being pushed.
#allowPushNull	Allows a push to this prop if the value is null.

Exposure
#expose_private	Prevents a prop from using a pipe during “get”.
#expose_private	Exposable only by pipe.
#expose_defs_readonly	Exposable through proxy for read only access.
#disable_pipe	Prevents a prop from using a pipe during “get”.

Copy
#copy_reference	Uses a put of this `PropDef` when a copy of the `PropObj` is used.
#copy_shallow	Copies the value of this `PropDef` when the parent object is copied.
#copy_shallow	Does not copy the value of this `PropDef` in any way when the object is copied.

Stream
#stream_null	Prevents this `PropDef`’s value from being streamed.

Animation Exclusive (Not Recommended for use, included only for completeness)
#remover	Used for the remover animation and vessels related to the remover tool. Removes all associated properties on `candidateChanged()`.
#classification	Used only in k2 abstract, removes related properties during `userPropertyChanged()` in the `K2FillerEmptySpaceAnimation`.
#basepointAlignAnimation	Used during a basepoint align animation to label properties.
#selectAnimation	Used during select animation to add and remove core properties containing this attribute.
#picker	Used during the `InspectorPickerAnimation` to add and remove properties.

Sym (In Testing)
#symdef	Allows a prop to be used as a `SymParams` without explicitly calling `setParam()`. (but `defineParam()` is still necessary, unless `sym=true` is set)
#symdef	Allows a prop to used as a `SymParams` to ignore caching.

Render UI Building (Included for Completeness, not recommended)
#"$generalSettings"	#"$sampling"
#"$caustics"	#"$useDenoising"
#"$misc"	#"$gi"

Others
#property	Automatically included with any `PropDef` that becomes a “property” of some sort.
#data	Used for `PropDefs` dealing with “Data” or “multidata”.
#lockable	Makes the factory lockable.