Foldit Lua Functions (v1)

This page lists the functions found in the obsolete version 1 of the Foldit Lua interface. See Foldit Lua Functions for the current version 2 functions.

Note: This page is generated from the output of the help command in the Foldit client. Please don't make changes to this page. Changes may be overwritten when the page is regenerated.

To add details for a particular function, click on the 'Details' link for the function and add comments there.

Use the 'Comments' section below for comments on this page as a whole. Comments are preserved when the page is updated.

Last updated: release 20170210-55c03a4ae1-win_x86

help Edit

Function: void help(function Func)
Description: Prints the signature and description of Func, or signature of all Foldit functions if no argument is given.
V2 Function Name: none
More Information: Details

are_conditions_met Edit

Function: boolean are_conditions_met()
Description: Return true if the current pose satisfies all conditions, or else return false.
V2 Function Name: current.AreConditionsMet
More Information: Details

band_add_segment_segment Edit

Function: void band_add_segment_segment(integer segment_index_1, integer segment_index_2)
Description: Add a band between the segments at 'segment_index_1' and at 'segment_index_2'.
V2 Function Name: band.AddBetweenSegments
More Information: Details

band_delete Edit

Function: void band_delete(integer band_index_1[, ..., integer band_index_n])
Description: Delete the bands at the given band indices.
V2 Function Name: band.Delete
More Information: Details

band_disable Edit

Function: void band_disable(integer band_index_1[, ..., integer band_index_n])
Description: Disable the bands at the given band indices.
V2 Function Name: band.Disable
More Information: Details

band_enable Edit

Function: void band_enable(integer band_index_1[, ..., integer band_index_n])
Description: Enable the bands at the given band indices.
V2 Function Name: band.Enable
More Information: Details

band_set_length Edit

Function: void band_set_length(integer band_index, number length)
Description: Set the length of the band at the given index.
V2 Function Name: band.SetGoalLength
More Information: Details

band_set_strength Edit

Function: void band_set_strength(integer band_index, number strength)
Description: Set the strength of the band at the given index.
V2 Function Name: band.SetStrength
More Information: Details

deselect_all Edit

Function: void deselect_all()
Description: Clear selection.
V2 Function Name: selection.DeselectAll
More Information: Details

deselect_index Edit

Function: void deselect_index(integer segment_index_1[, ..., integer segment_index_n])
Description: Deselect segments at the given indices. More than one segment index may be specified.
V2 Function Name: similar to selection.Deselect
More Information: Details

do_freeze Edit

Function: void do_freeze(boolean backbone, boolean sidechain)
Description: Freeze segments. If 'backbone' or 'sidechain' is true, freeze that part of the segment.
V2 Function Name: similar to freeze.FreezeSelected
More Information: Details

do_global_wiggle_all Edit

Function: void do_global_wiggle_all([integer iterations])
Description: Run global wiggle on backbone and sidechains. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: similar to structure.WiggleSelected
More Information: Details

do_global_wiggle_backbone Edit

Function: void do_global_wiggle_backbone([integer iterations])
Description: Run global wiggle on backbone. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: similar to structure.WiggleSelected
More Information: Details

do_global_wiggle_sidechains Edit

Function: void do_global_wiggle_sidechains([integer iterations])
Description: Run global wiggle on sidechains. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: similar to structure.WiggleSelected
More Information: Details

do_local_rebuild Edit

Function: void do_local_rebuild([integer iterations])
Description: Run local rebuild on selection. Run for 'iterations' iterationas if given; otherwise, until stopped.
V2 Function Name: structure.RebuildSelected
More Information: Details

do_local_wiggle Edit

Function: void do_local_wiggle([integer iterations])
Description: Run local wiggle. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: structure.LocalWiggleSelected
More Information: Details

do_mutate Edit

Function: void do_mutate([integer iterations])
Description: Run mutate. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: structure.MutateSidechainsSelected
More Information: Details

do_shake Edit

Function: void do_shake([integer iterations])
Description: Run shake. Run for 'iterations' iterations if given; otherwise, until stopped.
V2 Function Name: structure.ShakeSidechainsSelected
More Information: Details

do_sidechain_snap Edit

Function: void do_sidechain_snap(integer segment_index, integer snap_index)
Description: Snap the position of the sidechain at the given index to the given snap position.
V2 Function Name: rotamer.SetRotamer
More Information: Details

do_unfreeze_all Edit

Function: void do_unfreeze_all()
Description: Unfreeze all segments.
V2 Function Name: freeze.UnfreezeAll
More Information: Details

get_aa Edit

Function: string get_aa(integer segment_index_1[, ..., integer segment_index_n])
Description: Get segments' amino acid type at given segment indices.
V2 Function Name: structure.GetAminoAcid
More Information: Details

get_band_count Edit

Function: integer get_band_count()
Description: Return the number of bands.
V2 Function Name: band.GetCount
More Information: Details

get_exploration_score Edit

Function: number get_exploration_score()
Description: Return the Exploration Score. If the current Puzzle is not an Exploration Puzzle, returns 0.
V2 Function Name: current.GetExplorationMultiplier
More Information: Details

get_platform Edit

Function: string get_platform()
Description: Gets the platform name.
V2 Function Name: ui.GetPlatform
More Information: Details

get_ranked_score Edit

Function: number get_ranked_score([boolean negative_score])
Description: Return the score which the player is being ranked on. If negative_score is present and true, will return negative score, otherwise, negative scores will be 0.
V2 Function Name: current.GetScore
More Information: Details

get_score Edit

Function: number get_score([boolean negative_score])
Description: Return the current score. If negative_score is present and true, will return negative score, otherwise, negative scores will be 0.
V2 Function Name: current.GetScore
More Information: Details

get_segment_count Edit

Function: integer get_segment_count()
Description: Return the number of segments.
V2 Function Name: structure.GetCount
More Information: Details

get_segment_distance Edit

Function: number get_segment_distance(integer segment_index_1, integer segment_index_2)
Description: Return distance between 2 segments.
V2 Function Name: structure.GetDistance
More Information: Details

get_segment_score Edit

Function: number get_segment_score(integer segment_index_1[, ..., integer segment_index_n])
Description: Return the current score of the given segments. More than one segment index may be specified.
V2 Function Name: current.GetSegmentEnergyScore
More Information: Details

get_segment_score_part Edit

Function: number get_segment_score_part(string score_part, integer segment_index_1[, ..., integer segment_index_n])
Description: Return the current score part of the given segments. More than one segment index may be specified.
V2 Function Name: current.GetSegmentEnergySubscore
More Information: Details

get_sidechain_snap_count Edit

Function: integer get_sidechain_snap_count(integer segment_index)
Description: Return the number of positions the sidechain at the given index can snap to. NOTE: this number can change if the protein is moved.
V2 Function Name: rotamer.GetCount
More Information: Details

get_ss Edit

Function: string get_ss(integer segment_index_1[, ..., integer segment_index_n])
Description: Get segments' secondary structure type at given segment indices.
V2 Function Name: structure.GetSecondaryStructure
More Information: Details

is_hydrophobic Edit

Function: boolean is_hydrophobic(integer segment_index_1[, ..., integer segment_index_n])
Description: Get segments' hydrophobicity at given segment indices.
V2 Function Name: structure.IsHydrophobic
More Information: Details

load_structure Edit

Function: void load_structure()
Description: Load previously saved structure assignment
V2 Function Name: save.LoadSecondaryStructure
More Information: Details

print Edit

Function: void print(arg1[,...,argN])
Description: Prints the arguments to the output window and log file.
V2 Function Name: print
More Information: Details

quickload Edit

Function: void quickload(integer slot_number)
Description: Quickload from a slot
V2 Function Name: save.Quickload
More Information: Details

quicksave Edit

Function: void quicksave(integer slot_number)
Description: Quicksave to a slot
V2 Function Name: save.Quicksave
More Information: Details

replace_aa Edit

Function: void replace_aa(string aa)
Description: Replace segments' amino acid within selection with 'aa'.
V2 Function Name: structure.SetAminoAcidSelected
More Information: Details

replace_ss Edit

Function: void replace_ss(string ss)
Description: Replace segments' secondary structure within selection with 'ss'.
V2 Function Name: structure.SetSecondaryStructure
More Information: Details

reset_puzzle Edit

Function: void reset_puzzle()
Description: Reset puzzle to the starting configuration
V2 Function Name: puzzle.StartOver
More Information: Details

reset_recent_best Edit

Function: void reset_recent_best()
Description: Set this pose as recent best
V2 Function Name: recentbest.Restore
More Information: Details

restore_abs_best Edit

Function: void restore_abs_best()
Description: Restore to the absolute best pose
V2 Function Name: absolutebest.Restore
More Information: Details

restore_credit_best Edit

Function: void restore_credit_best()
Description: Restore to the best pose for which you have gotten credit
V2 Function Name: creditbest.Restore
More Information: Details

restore_recent_best Edit

Function: void restore_recent_best()
Description: Restore to the recent best pose
V2 Function Name: recentbest.Restore
More Information: Details

save_structure Edit

Function: void save_structure()
Description: Save current structure assignment
V2 Function Name: save.SaveSecondaryStructure
More Information: Details

select_all Edit

Function: void select_all()
Description: Select all segments.
V2 Function Name: selection.SelectAll
More Information: Details

select_index Edit

Function: void select_index(integer segment_index_1[, ..., integer segment_index_n])
Description: Select segments at the given indices. More than one segment index may be specified.
V2 Function Name: similar to selection.Select
More Information: Details

select_index_range Edit

Function: void select_index_range(integer segment_index_1, integer segment_index_2)
Description: Select all segments from (including) 'segment_index_1' to (including) 'segment_index_2'.
V2 Function Name: selection.SelectRange
More Information: Details

set_behavior_clash_importance Edit

Function: void set_behavior_clash_importance(number importance)
Description: Set the clashing importance to 'importance' (between 0 and 1).
V2 Function Name: behavior.SetClashImportance
More Information: Details

FANDOM