FindStruct - Array

From Creation Kit
Jump to: navigation, search

Member of: All Arrays

Locates a particular value in a struct inside an array and returns the index

Syntax

int Function FindStruct(StructVarName asVarName, ;/var type/; akElement, int aiStartIndex = 0) native

Parameters

  • asVarName: The name of the struct variable to compare with
  • akElement: The element to locate
  • aiStartIndex: Where to start the search
    • Default: 0

Return Value

The index of the struct in the array with the matching value, or a negative value if it was not found.

Examples

if (MyPointArray.FindStruct("X", 1) < 0)
  Debug.Trace("Did not find a point with an X of 1 in the array")
endIf


int firstPosition = MyPointArray.FindStruct("Y", 10)
Debug.Trace("Found a point with an Y of 10 at position " + firstPosition)
int secondPosition = MyPointArray.FindStruct("Y", 10, firstPosition + 1)
Debug.Trace("Found a second point with an Y of 10 at position " + secondPosition)

See Also