Carmenta Engine SDK Documentation

PlotIdCollection.Index Methods

This element is not available using the selected API.

PlotIdCollection.index Methods

Searches for the specified object and returns the zero-based index of the first occurrence.

Overload List

	Name	Description
Public method	index(item)	Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.
Public method	index(item, i)	Searches for the specified object and returns the zero-based index of the first occurrence within the collection starting at the specified index.
Public method	index(item, i, j)	Searches for the specified object and returns the zero-based index of the first occurrence within the collection starting in the specified range.

index(item)

Searches for the specified object and returns the zero-based index of the first occurrence within the entire collection.

Syntax

Python

int index ( item )

Parameters

item

Type: PlotId
The value to search for.

Return Value

Type: int
The zero-based index of the first occurrence of item in the collection, if found; otherwise, raises ValueError.

index(item, i)

Searches for the specified object and returns the zero-based index of the first occurrence within the collection starting at the specified index.

Syntax

Python

int index ( item, i )

Parameters

item

Type: PlotId
The value to search for.

Type: PlotId
The starting index of the search.

Return Value

Type: int
The zero-based index of the first occurrence of item at or after the starting index i, if found; otherwise, raises ValueError.

index(item, i, j)

Searches for the specified object and returns the zero-based index of the first occurrence within the collection starting in the specified range.

Syntax

Python

int index ( item, i, j )

Parameters

item

Type: PlotId
The value to search for.

Type: PlotId
The starting index of the search.

Type: PlotId
The first index beyond the search range.

Return Value

Type: int
The zero-based index of the first occurrence of item within in the range [i, j[, if found; otherwise, raises ValueError.

Platforms

Windows, Linux, Android

PlotIdCollection.Index Methods

PlotIdCollection.Index Methods

PlotIdCollection::index Methods

PlotIdCollection.index Methods

PlotIdCollection.index Methods

In this article

Overload List

index(item)

Syntax

Parameters

Return Value

index(item, i)

Syntax

Parameters

Return Value

index(item, i, j)

Syntax

Parameters

Return Value

Platforms

See Also

Reference