OrganismState.CompareTo Method

OrganismStateCompareTo Method

Compares two organism state objects together. This method takes into account the Y position for graphical Z-Ordering purposes and can be used to sort creatures for back to front rendering.

Namespace: Terrarium.Sdk.Classes.State
Assembly: Terrarium.Sdk (in Terrarium.Sdk.dll) Version: 1.1.0.0 (1.1.0.0)

Syntax

C++

Copy

public int CompareTo(
	Object other
)

Public Function CompareTo ( 
	other As Object
) As Integer

public:
virtual int CompareTo(
	Object^ other
) sealed

abstract CompareTo : 
        other : Object -> int 
override CompareTo : 
        other : Object -> int

Parameters

other: Type: SystemObject
The object to be compared. Has to be another OrganismState.

Return Value

Type: Int32
Less than 0 if the zOrder is less, 0 for equal, and greater than 0 for more.

Implements

IComparableCompareTo(Object)

Reference

OrganismState Class

Terrarium.Sdk.Classes.State Namespace