Differences

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

--- scripting:samples:dronetraining [2023/05/15 10:24] – created mit
+++ scripting:samples:dronetraining [2023/05/15 15:57] (current) – mit
@@ Line 22: / Line 22: @@
-Function	AddGameSelectOSD()
+Event( "AccessBuilding", "$kPlayGamePlinthBuildingType" )
 {
 	osdcreate(OSDBUILDING,"GameOSD", "" )
-	osdaddat(EXITBUTTON, 100, 80, 400, 35, "PlaySingle", "Example Single Player Game" )
+	osdadd(EXITBUTTON, 100, 80, 400, 35, "PlaySingle", "Example Single Player Game" )
 	osdactivate()
-}
-Event( "AccessBuilding", "$kPlayGamePlinthBuildingType" )
-{
-	AddGameSelectOSD()
 }
 </code>
@@ Line 74: / Line 70: @@
 //   It uses the $gPlayerKey[WaveNum] to determine which level we're on and then the baseIndex tells us where in
 //   each 'row' we should be looking.
+//  (Of course, we could do away with all this nonsense if the script language supported more than just integer arrays, but thats for another time :] )
 //---------------------
 Function	GetTableMinMaxVal( $baseIndex )
@@ Line 90: / Line 87: @@
 }
-// -------------------------------
-//  SpawnBadGuy
+///------------------------------------------------
-// Here we'll have some fun with entities.  The calling function has worked out where to spawn a new enemy,
+// The custom StartGame event is triggered from the game access building defined separately
-// So here we calculate some of its properties and then create the actual entity
+//------------------------------------
-//---
+Event( "Custom", "StartGame" )
-Function	SpawnBadGuy( $xpos, $ypos )
+{
+	// Delete all entities for the current player
+	EntityDeleteAll( $gPlayerID );
+	$gPlayerKey[NumEntitiesAlive] = 0
+	$gPlayerKey[WaveNum] = 1
+	$gPlayerKey[NumKills] = 0
+	SpawnMoreBadGuys()
+}
+///------------------------------------------------
+// SpawnMoreBadGuys
+//   Called at the start of each 'wave'/level to trigger a new wave
+//   of enemies
+//---------------------------------------------
+Function		SpawnMoreBadGuys( )
 {
 	$waveNum = $gPlayerKey[WaveNum]
+	*notifylarge %PLAYER% Wave $waveNum
-	$targetLeadPercentage = GetTableMinMaxVal( 2 )
+	$loop = 0
-	$moveSpeed = GetTableMinMaxVal( 4 )
-	$moveAcc = GetTableMinMaxVal( 6 )
-        //  Create an entity that is managed locally (i.e. is effectively just run for the one player)
-        //   with a HUNT behaviour. (This means the entity will attempt to hunt down the local player).
-        //  Note that the entity does not actually get sent to the player until we add it to the world, later in this function
-	$mhTestEntity = EntityCreate( $gPlayerID, "LOCAL", "HUNT"  )
-	// Note, currently all entity graphics need to be present in the game's main web content folder on the CDN
+	$waveTable = $waveNum - 1
-	EntitySetModel( $mhTestEntity, "uniRobocrow2.atm", "uniRobocrow2.jpg" )
+	$waveTable *= $kSizeOfWavesStruct
-	EntitySetPosition( $mhTestEntity, $xpos, $ypos, 0 )
+	$numEntitiesToSpawn = $maEnemyWaves[$waveTable+1]
-	// Behaviour Control flags
-      // FaceTarget = Set the entity to always to always look towards the target
-	EntitySetValue( $mhTestEntity, "FaceTarget", 1 )
-      // AttackProx = Start attacking when within the ProxRange
-	EntitySetValue( $mhTestEntity, "AttackProx", 1 )
-      // DieOnTargetDeath = Entity is destroyed if the target dies
-	EntitySetValue( $mhTestEntity, "DieOnTargetDeath", 1 )
-	// Parameters and values
-        // ZOffset = Vertical position offset above the ground
-	EntitySetValue( $mhTestEntity, "ZOffset", 800 )
-        // ProxRange = Used to determine attack range
-	EntitySetValue( $mhTestEntity, "ProxRange", 6000 )
-	$targetDist = $waveNum * 200
-	$targetDist += 2300
-        // Distance from the target the entity will try to maintain
-	EntitySetValue( $mhTestEntity, "TargetDist", $targetDist )
-        // Who the target is..
-	EntitySetValue( $mhTestEntity, "Target", $gPlayerID )
-	EntitySetValue( $mhTestEntity, "Weapon", 1 )
-        //  Basically this sets how good the entity is at aiming
-	EntitySetValue( $mhTestEntity, "TargetLead", $targetLeadPercentage )
-	$health = $waveNum * 25
+	while ( $loop < $numEntitiesToSpawn )
-	$health += 100
+	{
-        // Health = how much damage this entity can take before dieing
+		SpawnRandomHunter( 15000, 25000 )
-	EntitySetValue( $mhTestEntity, "Health", $health )
-        // Set Speed and acceleration (Determined by the level settings table)
+		$loop += 1
-	EntitySetValue( $mhTestEntity, "MoveSpeed", $moveSpeed )
+	}
-	EntitySetValue( $mhTestEntity, "MoveAcc", $moveAcc )
+	$gPlayerKey[NumEntitiesAlive] += $numEntitiesToSpawn
-        // Now all set.. add the entity to the world
-	EntityAddToWorld( $mhTestEntity )
 }
+//-------------------------------------------------
+// SpawnRandomHunter
+//   Earlier code has determined we need an extra enemy , and it provides the min/max range where
+//   that new enemy should appear. This function converts that range to an actual X,Y world position
+//   and then calls the 'SpawnBadGuy' function above to add an entity
+//------------------
 Function	SpawnRandomHunter( $minrange, $maxrange )
 {
@@ Line 201: / Line 188: @@
-Function		SpawnMoreBadGuys( )
+// -------------------------------
+//  SpawnBadGuy
+// Here we'll have some fun with entities.  The calling function has worked out where to spawn a new enemy,
+// So here we calculate some of its properties and then create the actual entity
+//---
+Function	SpawnBadGuy( $xpos, $ypos )
 {
 	$waveNum = $gPlayerKey[WaveNum]
-	*notifylarge %PLAYER% Wave $waveNum
-	$loop = 0
+	$targetLeadPercentage = GetTableMinMaxVal( 2 )
+	$moveSpeed = GetTableMinMaxVal( 4 )
+	$moveAcc = GetTableMinMaxVal( 6 )
+        //  Create an entity that is managed locally (i.e. is effectively just run for the one player)
+        //   with a HUNT behaviour. (This means the entity will attempt to hunt down the local player).
+        //  Note that the entity does not actually get sent to the player until we add it to the world, later in this function
+	$mhTestEntity = EntityCreate( $gPlayerID, "LOCAL", "HUNT"  )
-	$waveTable = $waveNum - 1
+	// Note, currently all entity graphics need to be present in the game's main web content folder on the CDN
-	$waveTable *= $kSizeOfWavesStruct
+	EntitySetModel( $mhTestEntity, "uniRobocrow2.atm", "uniRobocrow2.jpg" )
-	$numEntitiesToSpawn = $maEnemyWaves[$waveTable+1]
+	EntitySetPosition( $mhTestEntity, $xpos, $ypos, 0 )
+	// Behaviour Control flags
+      // FaceTarget = Set the entity to always to always look towards the target
+	EntitySetValue( $mhTestEntity, "FaceTarget", 1 )
+      // AttackProx = Start attacking when within the ProxRange
+	EntitySetValue( $mhTestEntity, "AttackProx", 1 )
+      // DieOnTargetDeath = Entity is destroyed if the target dies
+	EntitySetValue( $mhTestEntity, "DieOnTargetDeath", 1 )
+	// Parameters and values
+        // ZOffset = Vertical position offset above the ground
+	EntitySetValue( $mhTestEntity, "ZOffset", 800 )
+        // ProxRange = Used to determine attack range
+	EntitySetValue( $mhTestEntity, "ProxRange", 6000 )
+	$targetDist = $waveNum * 200
+	$targetDist += 2300
+        // Distance from the target the entity will try to maintain
+	EntitySetValue( $mhTestEntity, "TargetDist", $targetDist )
+        // Who the target is..
+	EntitySetValue( $mhTestEntity, "Target", $gPlayerID )
+	EntitySetValue( $mhTestEntity, "Weapon", 1 )
+        //  Basically this sets how good the entity is at aiming
+	EntitySetValue( $mhTestEntity, "TargetLead", $targetLeadPercentage )
-	while ( $loop < $numEntitiesToSpawn )
+	$health = $waveNum * 25
-	{
+	$health += 100
-		SpawnRandomHunter( 15000, 25000 )
+        // Health = how much damage this entity can take before dieing
+	EntitySetValue( $mhTestEntity, "Health", $health )
-		$loop += 1
+        // Set Speed and acceleration (Determined by the level settings table)
-	}
+	EntitySetValue( $mhTestEntity, "MoveSpeed", $moveSpeed )
+	EntitySetValue( $mhTestEntity, "MoveAcc", $moveAcc )
-	$gPlayerKey[NumEntitiesAlive] += $numEntitiesToSpawn
+        // Now all set.. add the entity to the world
+	EntityAddToWorld( $mhTestEntity )
 }
+///------------------------------------------------
+// Every time an entity is destroyed we update the player's kill count and decrease the
+//  count of enemies remaining. Once that gets to 0 we start the next wave
+//------------------------------------
 Event( "EntityDestroyed", "" )
 {
@@ Line 235: / Line 266: @@
 }
+///------------------------------------------------
+// GameEnd is triggered from RobocrowDeath Event and displays final score etc
+Event ("RobocrowDeath", "" )
+{
+	if ( $gPlayerKey[DroneGameMode] == 1 )
+	{
+		*event %PLAYER% GameEnd
+	}
+}
+//------------------------------------
 Event( "Custom", "GameEnd" )
 {
@@ Line 257: / Line 300: @@
 }
-Event ("RobocrowDeath", "" )
-{
-	if ( $gPlayerKey[DroneGameMode] == 1 )
-	{
-		*event %PLAYER% GameEnd
-	}
-}
-Event( "Custom", "StartGame" )
-{
-	// Delete all entities for the current player
-	EntityDeleteAll( $gPlayerID );
-	$gPlayerKey[NumEntitiesAlive] = 0
-	$gPlayerKey[WaveNum] = 1
-	$gPlayerKey[NumKills] = 0
-	SpawnMoreBadGuys()
-}
 </code>