Differences

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

--- scripting:reference:system_functions [2015/02/23 14:19] – mit
+++ scripting:reference:system_functions [2025/05/28 16:35] (current) – external edit 127.0.0.1
@@ Line 4: / Line 4: @@
 (Note also the list of [[Scripting:Reference:Special System Control Functions|special system control functions]] which includes special cases like the 'Sleep' function etc)
-===== Maths Functions =====
-==== sysRand ====
-^ Format | sysRand ( [MAX_NUM] )|
-^ Description | Returns a random number between 1 and the value specified |
-^ Example | ''**$var = Rand(500)**'' |
-==== sysSin ====
-^ Format | sysSin ( [ANGLE], [SCALE] )|
-^ Description | Returns a sine value|
-^ Parameters | Angle - 0 to 360 degrees |
-^  | Scale - Scale applied to the result from the sine function (which normally returns a value from -1 to 1 |
-^ Returns | Scaled sine value |
-//Example//: <note>
-<code>Event( "Custom", "TreeCircle" )
-{
-    $angle = 0
-    while ( $angle < 360 )
-    {
-        $posX = sysSin( $angle, 100 )
-        $posY = sysCos( $angle, 100 )
-        $posX += $gPlayerWorldX
-        $posY += $gPlayerWorldY
-        *addtree 1,$posX,$posY
-        $angle += 36
-    }
-}
-</code>
-</note>
-==== sysCos ====
-^ Format | sysCos ( [ANGLE], [SCALE] )|
-^ Description | Returns a cosine value|
-^ Parameters | Angle - 0 to 360 degrees |
-^  | Scale - Scale applied to the result from the cosine function (which normally returns a value from -1 to 1 |
-^ Returns | Scaled cosine value |
-//Example//: See sysSin above \\
-\\
-==== sysGetDist ====
-^ Format | sysGetDist ( [X1], [Y1], [X2], [Y2] )|
-^ Description | Calculates the distance between two points|
-^ Parameters | Point 1 X,Y |
-^  | Point 2 X,Y |
-^ Returns | Distance |
-//Example//: <note>
-<code>Event( "AccessBuilding", "1" )
-{
-    $dist = sysGetDist( $gPlayerWorldX, $gPlayerWorldY, $gBuildingWorldX, $gBuildingWorldY )
-    *msg %PLAYER% You accessed the building from $dist cm away
-}
-</code>
-</note>
 ===== Player-status Functions =====
@@ Line 87: / Line 33: @@
 ^ Parameters | **[index]** - Inventory slot number |
 ^ Returns | **[ItemNum]** - The item number in the specified inventory slot (or 0 if the slot is empty) |
-^ Notes | Players currently have 16 inventory slots. |
+^ Notes | Players currently have up to 64 inventory slots. |
 //Example//: <note>
 <code>Event( "Custom", "ListInventory" )
 {
     $loop = 0
-    while( $loop < 16 )
+    while( $loop < 64 )
     {
        $itemNum = sysGetInventoryItemIndex( $loop )
@@ Line 401: / Line 347: @@
     {
 	$buildingName = sysGetTextEntry()
-	$didAdd = sysAddBuildingWorld( nBuildingType,$gPlayerID,$gPlayerWorldX,$gPlayerWorldY,$buildingName )
+	$didAdd = sysAddBuilding( nBuildingType,$gPlayerID,$gPlayerX,$gPlayerY,$buildingName )
     }
 }
@@ Line 614: / Line 560: @@
 ==== sysGetRealTimeTextForDays ====
-TBD //
+^ Format | sysGetRealTimeTextForDays ( [Number of game days] )|
-//
+^ Description | Returns a text description of the time that will pass for the specified number of game days |
+^ Parameters | Number of game days |
+^ Returns | Time text |
+//Example//: <note>
+<code>Event( "UseItem", "Magic Potion" )
+{
+    $daysSinceLastUsed = $gGameDay - $gPlayerKey[LastUsedPotionDay]
+    if ( $daysSinceLastUsed < 10 )
+    {
+        $daysUntilCanUse = 10 - $daysSinceLastUsed
+        $timeText = sysGetRealTimeTextForDays( $daysUntilCanUse )
+        *say You must wait $timeText until you can use the Magic Potion again
+    }
+    else
+    {
+        *effect %PLAYER% 10
+        $gPlayerKey[LastUsedPotionDay] = $gGameDay
+    }
+}
+</code>
+</note>
 ===== Battle game Functions =====
@@ Line 629: / Line 594: @@
 ==== BattleSendChallenge ====
+===== Maths Functions =====
+==== sysRand ====
+^ Format | sysRand ( [MAX_NUM] )|
+^ Description | Returns a random number between 1 and the value specified |
+^ Example | ''**$var = Rand(500)**'' |
+==== sysSin ====
+^ Format | sysSin ( [ANGLE], [SCALE] )|
+^ Description | Returns a sine value|
+^ Parameters | Angle - 0 to 360 degrees |
+^  | Scale - Scale applied to the result from the sine function (which normally returns a value from -1 to 1 |
+^ Returns | Scaled sine value |
+//Example//: <note>
+<code>Event( "Custom", "TreeCircle" )
+{
+    $angle = 0
+    while ( $angle < 360 )
+    {
+        $posX = sysSin( $angle, 100 )
+        $posY = sysCos( $angle, 100 )
+        $posX += $gPlayerWorldX
+        $posY += $gPlayerWorldY
+        *addtree 1,$posX,$posY
+        $angle += 36
+    }
+}
+</code>
+</note>
+==== sysCos ====
+^ Format | sysCos ( [ANGLE], [SCALE] )|
+^ Description | Returns a cosine value|
+^ Parameters | Angle - 0 to 360 degrees |
+^  | Scale - Scale applied to the result from the cosine function (which normally returns a value from -1 to 1 |
+^ Returns | Scaled cosine value |
+//Example//: See sysSin above \\
+\\
+==== sysGetDist ====
+^ Format | sysGetDist ( [X1], [Y1], [X2], [Y2] )|
+^ Description | Calculates the distance between two points|
+^ Parameters | Point 1 X,Y |
+^  | Point 2 X,Y |
+^ Returns | Distance |
+//Example//: <note>
+<code>Event( "AccessBuilding", "1" )
+{
+    $dist = sysGetDist( $gPlayerWorldX, $gPlayerWorldY, $gBuildingWorldX, $gBuildingWorldY )
+    *msg %PLAYER% You accessed the building from $dist cm away
+}
+</code>
+</note>
 ===== Misc other functions =====