band.SetGoalLength
- Function
- void band.SetGoalLength(integer bandIndex, number length)
- Description
- Set the goal length of a band. (Range 0.0 to 10000.0)
- V1 Function Name
- band_set_length
Remarks
This is the "unstretched" or "true" length of the band. If the current length of the band (as set by band.Add or read by band.GetLength) is less than the goal length, the band will push the endpoints apart. If the current length is more than the goal length, it will pull the endpoints closer.
Sample
This script sets the length of all bands to 0.
for ii = 1, band.GetCount () do
band.SetGoalLength ( ii, 0)
end