problems with help() output
|Opened on:||Tuesday, May 26, 2015 - 23:22|
|Last modified:||Monday, July 30, 2018 - 19:48|
I'm considering updating the list of functions found at http://foldit.wikia.com/wiki/Foldit_Lua_Functions
This page can be generated (semi-) automatically with the information returned by the help() function and a fixed table of LUA v1 equivalents. In reviewing the help() output, I've noticed some problems. It would be helpful is these could be corrected in a future release.
One outright error is that structure.TweakRotate appears without the leading parenthesis on its argument list:
void structure.TweakRotateinteger segmentIndex, number angle)
Other helpful information is omitted. For example, text for behavior.GetSlowFiltersDisabled says "[d]eprecated - use GetFiltersDisabled", which is helpful. But other deprecated or no-op functions, such as structure.TweakRotate, are not identified. (As far as I can tell, structure.TweakRotate exists, but does nothing.)
The suspected no-op functions include:
void behavior.SetBandStrengthFactor(number factor)
void behavior.SetBuriedSidechainShakeAccuracy(number accuracy)
void behavior.SetExposedSidechainShakeAccuracy(number accuracy)
void behavior.SetShakeAccuracy(integer accuracy)
void behavior.SetWiggleAccuracy(number accuracy)
void structure.TweakRotate(integer segmentIndex, number angle)
void structure.TweakShift(integer segmentIndex, boolean shiftDirection)
void structure.TweakStraighten(integer segmentIndex)
It would be helpful if these function could be identified with "not implemented" or words to that effect.
Other functions, such as
may be deprecated. As with the filter-toggling functions, "deprecated" would be helpful.
Finally, it would be helpful for the basic score functions
to be differentiated, making clear which is preferred, and which is deprecated.