Add more compare functions (R2Northstar#156)

Co-authored-by: laund <[email protected]>
eve-v0 · Mar 14, 2023 · c8ee1b2 · c8ee1b2
1 parent 2b4dfe2
commit c8ee1b2
Showing 1 changed file with 47 additions and 13 deletions.
diff --git a/docs/source/reference/northstar/usefulfuncs.rst b/docs/source/reference/northstar/usefulfuncs.rst
@@ -294,27 +294,61 @@ Arrays
 .. cpp:function:: array.sort( compare_func = null )
 
 .. note::
-
 
-    Array Sort Functions: 
-
-    A few build in functions you can give as arguments to sort a function.
-
-    .. cpp:function:: int function SortLowest( var a, var b )
+    A few built-in functions you can give as arguments to sort an array.
 
-    .. cpp:function:: int function SortHighest( var a, var b )
+    .. dropdown:: Array Sort Functions
 
-    .. cpp:function:: int function SortItemsAlphabetically(var a, var b )
+        .. cpp:function:: int function SortLowest( var a, var b )
 
-    .. cpp:function:: int function SortAlphabetize( var a, var b )
-    
-    .. cpp:function:: int function SortStringAlphabetize( string a, string b )
+        .. cpp:function:: int function SortHighest( var a, var b )
 
-    .. cpp:function:: int function SortStringAsset( asset a, asset b )
+        .. cpp:function:: int function SortItemsAlphabetically(var a, var b )
 
-    .. cpp:function:: int function SortBySpawnTime( entity a, entity b )
+        .. cpp:function:: int function SortAlphabetize( var a, var b )
 
+        .. cpp:function:: int function SortStringAlphabetize( string a, string b )
+
+        .. cpp:function:: int function SortStringAsset( asset a, asset b )
+
+        .. cpp:function:: int function SortBySpawnTime( entity a, entity b )
     
+        Functions for score comparison
+
+        .. cpp:function:: int function CompareKills( entity a, entity b )
+
+        .. cpp:function:: int function CompareAssaultScore( entity a, entity b )
+
+        .. cpp:function:: int function CompareScore( entity a, entity b )
+
+        .. cpp:function:: int function CompareAssault( entity a, entity b )
+
+        .. cpp:function:: int function CompareDefense( entity a, entity b )
+
+        .. cpp:function:: int function CompareLTS( entity a, entity b )
+
+        .. cpp:function:: int function CompareCP( entity a, entity b )
+
+        .. cpp:function:: int function CompareCTF( entity a, entity b )
+
+        .. cpp:function:: int function CompareSpeedball( entity a, entity b )
+
+        .. cpp:function:: int function CompareMFD( entity a, entity b )
+
+        .. cpp:function:: int function CompareScavenger( entity a, entity b )
+
+        .. cpp:function:: int function CompareFW( entity a, entity b )
+
+        .. cpp:function:: int function CompareHunter( entity a, entity b )
+
+        .. cpp:function:: int function CompareATCOOP( entity a, entity b )
+
+        .. cpp:function:: int function CompareFD( entity a, entity b )
+
+        .. cpp:function:: int function CompareTitanKills( entity a, entity b )
+
+
+
 .. cpp:function:: array.reverse()
     
     reverse the array in place