OverlayPluginInfo Struct Reference

Object gathering all relevant information about an installed overlay plugin. More...

Inherits IComparable< OverlayPluginInfo >.

Public Member Functions
int	CompareTo (object obj)
	IComparable implementation More...
int	CompareTo (OverlayPluginInfo other)
	IComparable implementation More...

Public Attributes
readonly int	InteractionVertices
	Number of vertices that are being used for user interaction
readonly int	DefinitionVertices
	Number of vertices that are necessary to define the overlay plugin's appearance
readonly string	Name
	The "friendly-name" of the plugin.

Static Public Attributes
static readonly OverlayPluginInfo	Empty
	The null element

Detailed Description

Object gathering all relevant information about an installed overlay plugin.

Member Function Documentation

CompareTo() [1/2]

int CompareTo

(

object

obj

)

IComparable implementation

Parameters

obj	object to compare to

Returns

value	meaning
Less than zero	if the name of this overlay plugin precedes that of the overlay plugin referred to by obj
0	if the name of this overlay plugin is identical to that of the overlay plugin referred to by obj
-1	if the name of this overlay plugin follows that of the overlay plugin referred to by obj or if obj is null.

Exceptions

InvalidCastException

if obj does not refer to an object derived from OverlayPluginInfo.

CompareTo() [2/2]

int CompareTo

(

OverlayPluginInfo

other

)

IComparable implementation

Parameters

other

object to compare to

Returns

value	meaning
Less than zero	if the name of this overlay plugin precedes that of the overlay plugin referred to by other
0	if the name of this overlay plugin is identical to that of the overlay plugin referred to by other
-1	if the name of this overlay plugin follows that of the overlay plugin referred to by other .