Difference between revisions of "GetAt - FormList"
Jump to navigation
Jump to search
imported>Jimhsu |
imported>Cipscis (→Examples: Small improvements to newly added "GetFormIndex" example, based on a version of it I'd written earlier) |
||
| Line 29: | Line 29: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
int Function GetFormIndex(FormList List, Form Member) global | |||
{Gets the index of Member in List. Returns -1 if not found} | |||
if (!List.HasForm(Member)) | |||
int | Return -1 | ||
endif | |||
int Index = 0 | |||
While (List.GetAt(Index) != Member) | |||
Index += 1 | |||
EndWhile | EndWhile | ||
Return Index | |||
EndFunction | EndFunction | ||
</source> | </source> | ||
Revision as of 04:57, 19 February 2012
Member of: FormList Script
Returns the form at a specified index in the list.
Syntax
Form Function GetAt(int aiIndex) nativeParameters
- 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
EndWhileint Function GetFormIndex(FormList List, Form Member) global
{Gets the index of Member in List. Returns -1 if not found}
if (!List.HasForm(Member))
Return -1
endif
int Index = 0
While (List.GetAt(Index) != Member)
Index += 1
EndWhile
Return Index
EndFunction