GetAt - FormList

Member of: FormList Script

Returns the form at a specified index in the list.

Syntax

Form Function GetAt(int aiIndex) native

Parameters

• aiIndex: The index in the list we want to fetch the form from
  • The index is 0-based. If a list has 3 items in it, valid indices are: 0, 1 and 2

Return Value

Returns the form at index aiIndex, none in case of error (such as wrong index value)

Examples

; Print out the forms in the list
FormList property list auto
int index = 0
While (index < list.GetSize())
  Debug.Trace("Form " + index + " is " + list.GetAt(index))
  index = index + 1
EndWhile

; Gets the index of item f in formlist l, returns -1 if not found.
int function getFormIndex(FormList l,Form f)
	int r = -1
	int c = 0
	while (c < l.getSize())
		if (f == (l.GetAt(c) as Form))
			r = c
		EndIf
		c += 1
	EndWhile
	return r
EndFunction

See Also

• FormList Script
• GetSize - FormList