Murl Engine Lua Addon API  Version 1.0 beta
Murl.Graph.IIndexed

The IIndexed property interface.

This interface provides a common way to set a generic index for an object. The meaning of the index property is not explicitly defined; nodes may use the given value for e.g. indexing into their children (see Graph::ISwitch), indexing into an atlas resource (see Graph::IPlaneSequenceGeometry) or whatever other purpose suitable.

Animation controllers may call the SetIndex() method when index keys are present in a given Resource::IAnimation.


Table members

Enumerations


Index

Murl.Graph.IIndexed.INDEX_NONE


Functions



Methods


SetIndex(index)

Set the current index.

Boolean SetIndex(Integer index)

Parameters
indexThe signed index to set.
Returns
Boolean true if successful.

GetIndex()

Get the current index.

Integer GetIndex()

Returns
Integer The current index.

GetFirstIndex()

Get the lowest valid index.

Integer GetFirstIndex()

Returns
Integer The lowest valid index.

GetNumberOfIndices()

Get the total number of valid indices.

Integer GetNumberOfIndices()

Returns
Integer The total number of indices.