HPL2/HPL2 Helper Scripts/Spawner - Revision history

Mrbehemo at 23:28, 22 December 2023

2023-12-22T23:28:04Z

Mrbehemo at 23:21, 22 December 2023

2023-12-22T23:21:34Z

Mrbehemo at 23:20, 22 December 2023

2023-12-22T23:20:56Z

Mrbehemo at 23:19, 22 December 2023

2023-12-22T23:19:21Z

Mrbehemo at 23:18, 22 December 2023

2023-12-22T23:18:29Z

Mrbehemo at 23:16, 22 December 2023

2023-12-22T23:16:47Z

Mrbehemo at 16:49, 26 November 2023

2023-11-26T16:49:01Z

Mrbehemo at 16:47, 26 November 2023

2023-11-26T16:47:57Z

Mrbehemo at 16:47, 26 November 2023

2023-11-26T16:47:23Z

Mrbehemo at 16:46, 26 November 2023

2023-11-26T16:46:13Z

@@ Line 147: / Line 147: @@
 <syntaxhighlight lang="cpp">
 // Example:
-Spawner.SpawnEntityAtPos("AcmeAnvil", "anvil.ent", Math.GetPlayerPosVec() + cVector(0.0f, 3.0f, 0.0f))
+Spawner.SpawnEntityAtPos("AcmeAnvil", "anvil.ent", Math.GetPlayerPosVec() + cVector(0.0f, 3.0f, 0.0f));
 // An entity of the type "anvil.ent" spawns 3m above the player's location.
 </syntaxhighlight>

@@ Line 94: / Line 94: @@
 <syntaxhighlight lang="cpp">
 // Example:
-Spawner.SpawnArea = "LibraryEntraceTriggerB";
+Spawner.SpawnArea = "LibraryEntranceTriggerB";
 // Spawner will use the Script Area named "LibraryEntranceTriggerB" instead of the default name.
 </syntaxhighlight>

@@ Line 95: / Line 95: @@
 // Example:
 Spawner.SpawnArea = "LibraryEntraceTriggerB";
-// Spawner will use the Script Area named "LibraryEntraceTriggerB" instead of the default name.
+// Spawner will use the Script Area named "LibraryEntranceTriggerB" instead of the default name.
 </syntaxhighlight>

@@ Line 44: / Line 44: @@
 Spawner does not save any data of its own. By default, entities created by Spawner will be saved along with the save game and Spawner will have no need to remember them on the next play session. The SaveEntities property can be used to change this behaviour at run-time. Its default is true.
 <syntaxhighlight lang="cpp">
-Spawn.SpawnEntityAtPos("ent1", "spookyChair.ent", cVector(0.0f, 0.0f, 0.0f));		// This new entity will save by *default*.
+Spawner.SpawnEntityAtPos("ent1", "spookyChair.ent", cVector(0.0f, 0.0f, 0.0f));		// This new entity will save by *default*.
 Spawner.SaveEntities = false;
-Spawn.SpawnEntityAtPos("ent2", "spookyTable.ent", cVector(2.0f, 0.0f, 0.0f));		// This new entity will *not* save, specifically.
+Spawner.SpawnEntityAtPos("ent2", "spookyTable.ent", cVector(2.0f, 0.0f, 0.0f));		// This new entity will *not* save, specifically.
 Spawner.SaveEntities = true;
-Spawn.SpawnEntityAtPos("ent3", "spookyCrate.ent", cVector(4.0f, 0.0f, 0.0f));		// This new entity *will* save, specifically.
+Spawner.SpawnEntityAtPos("ent3", "spookyCrate.ent", cVector(4.0f, 0.0f, 0.0f));		// This new entity *will* save, specifically.
 </syntaxhighlight>

@@ Line 36: / Line 36: @@
 In order to spawn particle systems, Spawner spawns a "temp entity" - an invisible entity that the particle system is attached to. The number of temp entities is limited (256 by default) and when the full number is reached, older ones will be recycled.
-If Spawner is uesed to create entities without specifying a name for them, they will be treated like temp entities too.
+If Spawner is used to create entities without specifying a name for them, they will be treated like temp entities too.
 The entity file used for temp entities is called "SpawnerTemp.ent" and is located in the ""HPL2HelperScripts" folders. This can be changed using the TempEntityFile property, if required for some reason.

@@ Line 10: / Line 10: @@
 There are three options for using Spawner, regarding a Spawn Area:
-# Simply add a Script Area to the level named "SpawnerArea", anywhere, any size.
+# Simply add a Script Area to the level named "SpawnArea", anywhere, any size.
 # Tell Spawner to use a Script Area that already exists in the map, anywhere, any size, regardless of any other purpose.
 # Tell Spawner to use multiple Script Areas placed in the map especially. This is only useful for semi-random rotation.

@@ Line 365: / Line 365: @@
 Spawner.SetSpawnArea("MyScriptArea");
 Spawner.SpawnEntitiesInBox("Hammer", "hammer.ent", 24, cVector(10.0f, 0.25f, 15.0f), cVector(15.0f, 0.25f, 20.0f));
-// 24x hammer.ent will be spawned in the defined area.
+// 24x hammer.ent will be spawned in the defined bos.
 // Example 2:
@@ Line 371: / Line 371: @@
 Spawner.SetSpawnArea(sAreas);
 Spawner.SpawnEntitiesInBox("Hammer", "hammer.ent", 24, cVector(10.0f, 0.25f, 15.0f), cVector(15.0f, 0.25f, 20.0f));
-// 24x hammer.ent will be spawned in the defined area, each with the rotation copied from one of the 4 script areas.
+// 24x hammer.ent will be spawned in the defined box, each with the rotation copied from one of the 4 script areas.
 </syntaxhighlight>

@@ Line 359: / Line 359: @@
 <br>However, the SetSpawnArea() method can also be used to specify multiple Script Areas with an array or list. If multiple Script Areas are specified then one of them will be selected at random for each item spawned.
 <br>This has only one advantage: spawned items take on the rotation of their Spawn Area.
-<br>If the desired outcome is to spawn objects with random rotation, the only way to achieve this through script to create a handful of Areas with various rotations, assign them all the SetSpawnArea(), and then each spawned item will take on the rotation of one of the areas.
+<br>If the desired outcome is to [[HPL2/HPL2_Helper_Scripts/Spawner#Spawning_with_rotation|spawn objects with random rotation]], the only way to achieve this through script to create a handful of Areas with various rotations, assign them all the SetSpawnArea(), and then each spawned item will take on the rotation of one of the areas.
 #''string asSpawnArea, string[] asSpawnAreaArray, cListString, asSpawnAreaList'' - One or more names to be designated as the spawn area.
 <syntaxhighlight lang="cpp">

@@ Line 28: / Line 28: @@
 It isn't possible to set the world rotation of an entity through script alone. However, spawned items will match the rotation of the whatever Script Area they were spawned at.
-The SpawnArea propery allows one specific area to be set, but the [[HPL2/HPL2_Helper_Scripts/Spawner#SetSpawnArea|SetSpawnArea()]] ''method'' will accept an array or list of area names. When more than one Spawn Area is set, each spawned item will choose a different one at random. Having multiple Spawn Areas has no advantage other than having multiple sources for rotation.
+The SpawnArea propery allows one specific area to be set, but the [[HPL2/HPL2_Helper_Scripts/Spawner#SetSpawnArea.28.29|SetSpawnArea()]] ''method'' will accept an array or list of area names. When more than one Spawn Area is set, each spawned item will choose a different one at random. Having multiple Spawn Areas has no advantage other than having multiple sources for rotation.
-For example, if the desired outcome is to spawn many debris objects with random-ish rotations, multiple Script Areas should be created in the level and given specific names and different rotations. It doesn't matter what size or location they are, only their rotation matters. In script, they should all be assigned with SetSpawnArea(), and then each spawned item will take on the rotation of one of the areas at random.
+For example, if the desired outcome is to spawn many debris objects with random-ish rotations, multiple Script Areas should be created in the level and given specific names and different rotations. It doesn't matter what size or location they are, only their rotation matters. In script, they should all be assigned with [[HPL2/HPL2_Helper_Scripts/Spawner#SetSpawnArea.28.29|SetSpawnArea()]], and then each spawned item will take on the rotation of one of the areas at random.