Differences

This shows you the differences between two versions of the page.

--- scripting:samples:hiscoretable [2023/04/17 12:22] – created mit
+++ scripting:samples:hiscoretable [2023/04/23 18:40] (current) – mit
@@ Line 1: / Line 1: @@
-$kScoreboardName = "SoloTimeTrial"
+This script demonstrates use of the sysHiscores functions.
+A &command function is included demonstrating how to add scores to the table.
-function		HiscoreDisplay()
+The script uses a module variable '$kScoreboardName' to identify the board.. you can change this to whatever you like and you can create multiple scoreboards just by using different names.
+The example shows a board that stores times and the board is ordered so the lowest time is at the top of the score table.
+<code>
+$kScoreboardName = "SampleHiscore"
+function	HiscoreDisplay( $boardName )
 {
 	osdcreate( OSDWINDOW,"HiscoresOSD", "" )
@@ Line 13: / Line 21: @@
 	$colName =  180
 	$colScore = 400
-	sysHiscoreTable( $kScoreboardName, 0, 10 )
 	while( $loop < 10 )
 	{
-		$score = sysHiscoreGetScore( $kScoreboardName, $loop )
+		$score = sysHiscoreGetScore( $boardName, $loop )
 		if ( $score > 0 )
 		{
 			$rank = $loop + 1
 			osdadd( TEXT, $colCount, $liney, 0, 0, "", "$rank" )
-			$name = sysHiscoreGetName( $kScoreboardName, $loop )
+			$name = sysHiscoreGetName( $boardName, $loop )
 			osdadd( TEXT, $colName, $liney, 0, 0, "", "$name" )
@@ Line 47: / Line 53: @@
 Event( "&command", "testscoreadd" )
 {
+        // Create the board with max 10 entries. Mode 0 means lowest values at top (Mode 1 is the reverse)
 	sysHiscoreTable( $kScoreboardName, 0, 10 )
 	$entry = sysHiscoreAdd( $kScoreboardName, 100, "Bruce")
-	*say Bruce added to hiscore, position $entry
 	$entry = sysHiscoreAdd( $kScoreboardName, 10, "Bob")
-	*say Bob added to hiscore, position $entry
 	$entry = sysHiscoreAdd( $kScoreboardName, 200, "Jim")
-	*say Jim added to hiscore, position $entry
 	$entry = sysHiscoreAdd( $kScoreboardName, 50, "Frank")
-	*say Frank added to hiscore, position $entry
 }
 Event( "&command", "testscoredisplay" )
 {
-	HiscoreDisplay()
+	HiscoreDisplay( $kScoreboardName )
 }
+</code>