MoreMountains.Tools.MMCircularList< T > Class Template Reference

A improved list that lets you parse it and automatically have it loop to the start or end when you reach the end or start To use it : set the CurrentIndex to whatever you want, then use IncrementCurrentIndex / DecrementCurrentIndex to move it, get the current element via Current. More...

Inheritance diagram for MoreMountains.Tools.MMCircularList< T >:

Public Member Functions
virtual void	IncrementCurrentIndex ()
	Increments the current index (towards the "right" of the list)
virtual void	DecrementCurrentIndex ()
	Decrements the current index (towards the "left" of the list)

Protected Member Functions
virtual int	GetCurrentIndex ()
	Computes the current index.

Properties
int	CurrentIndex [get, set]
	Lets you set the current index, or compute it if you get it.
virtual T	Current [get]
	Returns the current element.
virtual int	PreviousIndex [get]
	Returns the previous index in the circular list.
virtual int	NextIndex [get]
	Returns the next index in the circular list.

Detailed Description

A improved list that lets you parse it and automatically have it loop to the start or end when you reach the end or start To use it : set the CurrentIndex to whatever you want, then use IncrementCurrentIndex / DecrementCurrentIndex to move it, get the current element via Current.

Template Parameters

T

Member Function Documentation

DecrementCurrentIndex()

virtual void MoreMountains.Tools.MMCircularList< T >.DecrementCurrentIndex ( )

virtual

Decrements the current index (towards the "left" of the list)

GetCurrentIndex()

virtual int MoreMountains.Tools.MMCircularList< T >.GetCurrentIndex ( )

protectedvirtual

Computes the current index.

Returns

IncrementCurrentIndex()

virtual void MoreMountains.Tools.MMCircularList< T >.IncrementCurrentIndex ( )

virtual

Increments the current index (towards the "right" of the list)

Property Documentation

Current

virtual T MoreMountains.Tools.MMCircularList< T >.Current

get

Returns the current element.

CurrentIndex

int MoreMountains.Tools.MMCircularList< T >.CurrentIndex

getset

Lets you set the current index, or compute it if you get it.

NextIndex

virtual int MoreMountains.Tools.MMCircularList< T >.NextIndex

get

Returns the next index in the circular list.

PreviousIndex

virtual int MoreMountains.Tools.MMCircularList< T >.PreviousIndex

get

Returns the previous index in the circular list.

---

The documentation for this class was generated from the following file:

• Assets/CorgiEngine/ThirdParty/MoreMountains/MMTools/Core/MMHelpers/MMCircularList.cs