HPL2/HPL2 Helper Scripts/Bobber - Revision history

Mrbehemo at 23:40, 13 December 2023

2023-12-13T23:40:22Z

Mrbehemo at 17:06, 30 November 2023

2023-11-30T17:06:46Z

Mrbehemo at 16:36, 30 November 2023

2023-11-30T16:36:38Z

Mrbehemo at 16:34, 30 November 2023

2023-11-30T16:34:43Z

Mrbehemo at 16:33, 30 November 2023

2023-11-30T16:33:54Z

Mrbehemo: Added abstract bobbers

2023-11-30T16:25:32Z

Added abstract bobbers

Mrbehemo at 17:41, 26 November 2023

2023-11-26T17:41:16Z

Mrbehemo: Changed "units" to "m"

2023-11-26T16:51:34Z

Changed "units" to "m"

Mrbehemo: /* Player distance */

2023-11-26T16:50:33Z

Player distance

Mrbehemo: Added missing "example" labels.

2023-11-25T17:35:10Z

Added missing "example" labels.

← Older revision		Revision as of 23:40, 13 December 2023
Line 4:		Line 4:

	=Summary=		=Summary=
−	The script class cBobber manages a list of entities that should bob up and down, as if they are floating in water or hovering in air. A use case for this might be for a haunted item that hovers in the air temporarily. Or for example, if you need an entity to float in water in a specific location and can't ~~relay~~ on the physics simulation.	+	The script class cBobber manages a list of entities that should bob up and down, as if they are floating in water or hovering in air. A use case for this might be for a haunted item that hovers in the air temporarily. Or for example, if you need an entity to float in water in a specific location and can't rely on the physics simulation.

@@ Line 26: / Line 26: @@
 '''Advanced users''' may wish to examine "HelperScripts_Bobber.hps" to see how it makes use of other script classes. There are also some private variables that could to tweaked to fit the needs of a specific project, such as default player distance or the maximum number of bobbers.
-The methods [[HPL2/HPL2_Helper_Scripts/Bobber#AddAbstract.28.29|AddAbstract()]] and [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] can be used without a world entity, which means that Bobber can also be used just as a source of waving floats.
+The methods [[HPL2/HPL2_Helper_Scripts/Bobber#AddAbstract.28.29|AddAbstract()]] and [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] can be used without a world entity, which means that Bobber can also be used just as a source of waving floats. Abstract bobbers are not saved.
@@ Line 151: / Line 151: @@
 bool AddAbstract(string asName, cVector avDist, cVector avSpeed, cVector avPhase)
 </syntaxhighlight>
-Adds an abstract bobber to the list. An abstract bobber doesn't have a corresponding entity in the world, but can be used with [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] to return the bobbing vector for use in other ways.
+Adds an abstract bobber to the list. An abstract bobber doesn't have a corresponding entity in the world, but can be used with [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] to return the bobbing vector for use in other ways. Abstract bobbers are not saved in the game variables.
 #''string asName'' - The name to give the abstract bobber in the bob list.
 #''cVector avDist'' - Distance in X,Y,Z dimensions for size of the wave.

@@ Line 149: / Line 149: @@
 ====AddAbstract()====
 <syntaxhighlight lang="cpp">
-bool AddAbstract(string asEntity, cVector avDist, cVector avSpeed, cVector avPhase)
+bool AddAbstract(string asName, cVector avDist, cVector avSpeed, cVector avPhase)
 </syntaxhighlight>
 Adds an abstract bobber to the list. An abstract bobber doesn't have a corresponding entity in the world, but can be used with [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] to return the bobbing vector for use in other ways.
-#''string asEntity'' - The entity to add.
+#''string asName'' - The name to give the abstract bobber in the bob list.
 #''cVector avDist'' - Distance in X,Y,Z dimensions for size of the wave.
 #''cVector avSpeed'' - Velocity in X,Y,Z dimensions for speed of the wave.

← Older revision		Revision as of 16:34, 30 November 2023
Line 26:		Line 26:
	'''Advanced users''' may wish to examine "HelperScripts_Bobber.hps" to see how it makes use of other script classes. There are also some private variables that could to tweaked to fit the needs of a specific project, such as default player distance or the maximum number of bobbers.		'''Advanced users''' may wish to examine "HelperScripts_Bobber.hps" to see how it makes use of other script classes. There are also some private variables that could to tweaked to fit the needs of a specific project, such as default player distance or the maximum number of bobbers.

−	The methods [[HPL2/HPL2_Helper_Scripts/Bobber#AddAbstract.28.29\|AddAbstract()]] and [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29\|GetBob()]] can be used without a world entity, which means that Bobber can ~~provide~~ a source of waving floats.	+	The methods [[HPL2/HPL2_Helper_Scripts/Bobber#AddAbstract.28.29\|AddAbstract()]] and [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29\|GetBob()]] can be used without a world entity, which means that Bobber can also be used just as a source of waving floats.

@@ Line 25: / Line 25: @@
 ===Advanced info===
 '''Advanced users''' may wish to examine "HelperScripts_Bobber.hps" to see how it makes use of other script classes. There are also some private variables that could to tweaked to fit the needs of a specific project, such as default player distance or the maximum number of bobbers.
@@ Line 147: / Line 149: @@
 ====AddAbstract()====
 <syntaxhighlight lang="cpp">
-bool Add(string asEntity, cVector avDist, cVector avSpeed, cVector avPhase)
+bool AddAbstract(string asEntity, cVector avDist, cVector avSpeed, cVector avPhase)
 </syntaxhighlight>
-Adds an abstract bobber to the list. An abstract bobber doesn't have a corresponding entity in the world, but can be used with GetBob() to return the bobbing vector for use in other ways.
+Adds an abstract bobber to the list. An abstract bobber doesn't have a corresponding entity in the world, but can be used with [[HPL2/HPL2_Helper_Scripts/Bobber#GetBob.28.29|GetBob()]] to return the bobbing vector for use in other ways.
 #''string asEntity'' - The entity to add.
 #''cVector avDist'' - Distance in X,Y,Z dimensions for size of the wave.
 #''cVector avSpeed'' - Velocity in X,Y,Z dimensions for speed of the wave.
 #''cVector avPhase'' - Distance in X,Y,Z dimensions for time offset of the wave.
-<br>
+<syntaxhighlight lang="cpp">
@@ Line 225: / Line 233: @@
 cVector GetBob(string asName)
 </syntaxhighlight>
-Returns a 3d vector indicating the bobber's position. This is most useful with abstract bobbers and will be the current wave vector offset.
+Returns a 3d vector indicating the bobber's position. This is most useful with [[HPL2/HPL2_Helper_Scripts/Bobber#AddAbstract.28.29|abstract bobbers]] and will be the current wave vector offset.
 <br>For a normal bobber that is active, this will be its current world position. For an inactive bobber, this will return zero.
-<br>
+<syntaxhighlight lang="cpp">

@@ Line 143: / Line 143: @@
 // An entity called "floatyBoi" has been added to Bobber, with some unusual parameters. It will bob around 0,10,0. It will drift up and down slowly, over a range of 8m, but it will vibrate rapidly in both horizontal directions, and it will only do this while the player is within a distance of 4m.
 </syntaxhighlight>
@@ Line 196: / Line 208: @@
-====DebugOutput()====
+====IsEntBobbing()====
 <syntaxhighlight lang="cpp">
-void DebugOutput()
+bool IsEntBobbing(string asEntity)
 </syntaxhighlight>
-Writes out the list of bobbing entities as a Debug message with priority 3.
+Returns true if the named entity is in the bob list.
 <br>
@@ Line 215: / Line 241: @@
 cNodeBobbing(string &in asEntity, cVector avDist, cVector avSpeed, float afMaxPlayerDist)
 cNodeBobbing(string &in asEntity, bool abStartActive, cVector avMoveTo, cVector avDist, cVector avSpeed, cVector avPhase, float afMaxPlayerDist)
 </syntaxhighlight>
@@ Line 294: / Line 324: @@
 </syntaxhighlight>
 Updates the bobber's wave position based on the the current time and Bobber's interpolation weight value.
 #''float afTime'' - The current Bobber time.
 #''float afInterpWeight'' - The interpolation weight value in Bobber. Higher numbers make more smoothing. 4.0f is recommended.

← Older revision		Revision as of 17:41, 26 November 2023
Line 16:		Line 16:

	===Player distance===		===Player distance===
−	Each bobbing entity can have a specific distance ~~within which~~ the player must be for the bobbing animation to occur. When the player is beyond this distance, the animation will pause. The level designer should balance the player distance against the size of the entity, the size of it's bobbing movement, and the size of the space the player might see it in. The default distance is 24m, but this can be overridden in the Add() arguments.	+	Each bobbing entity can have a specific distance that the player must be within for the bobbing animation to occur. When the player is beyond this distance, the animation will pause. The level designer should balance the player distance against the size of the entity, the size of it's bobbing movement, and the size of the space the player might see it in. The default distance is 24m, but this can be overridden in the Add() arguments.

@@ Line 17: / Line 17: @@
 ===Player distance===
 Each bobbing entity can have a specific distance within which the player must be for the bobbing animation to occur. When the player is beyond this distance, the animation will pause. The level designer should balance the player distance against the size of the entity, the size of it's bobbing movement, and the size of the space the player might see it in. The default distance is 24m, but this can be overridden in the Add() arguments.
 ===Save data===
@@ Line 140: / Line 141: @@
 // Example 4:
 Bobber.Add("floatyBoi", false, cVector(0.0f, 10.0f, 0.0f), cVector(0.5f, 8.0f, 0.5f), cVector(16.0f, 2.0f, 16.0f), cVector(), 4.0f);
-// An entity called "floatyBoi" has been added to Bobber, with some unusual parameters. It will bob around 0,10,0. It will drift up and down slowly, over a range of 8 units, but it will vibrate rapidly in both horizontal directions, and it will only do this while the player is within a distance of 4 units.
+// An entity called "floatyBoi" has been added to Bobber, with some unusual parameters. It will bob around 0,10,0. It will drift up and down slowly, over a range of 8m, but it will vibrate rapidly in both horizontal directions, and it will only do this while the player is within a distance of 4m.
 </syntaxhighlight>

@@ Line 25: / Line 25: @@
 ===Advanced info===
 '''Advanced users''' may wish to examine "HelperScripts_Bobber.hps" to see how it makes use of other script classes. There are also some private variables that could to tweaked to fit the needs of a specific project, such as default player distance or the maximum number of bobbers.
 =Bobber=
@@ Line 48: / Line 49: @@
 The read-only boolean property IsActive returns whether there are currently any active bobbers.
 <syntaxhighlight lang="cpp">
 if (Bobber.IsActive) DoStuff();
 // The condition succeeds if Bobber is currently bobbing some entities.
@@ Line 59: / Line 61: @@
 The read-only integer property BobberCount returns the number of bobbers that have been registered in Bobber.
 <syntaxhighlight lang="cpp">
 if (Bobber.BobberCount < 8) MoarBobbers();
 // The condition succeeds if Bobber is currently bobbing fewer than eight entities.
@@ Line 70: / Line 73: @@
 The float property FrameRate can be used to get or set the animation frame rate that Bobber uses. Default = 30. For lower distances and speeds, 30 fps looks fine! For faster or more turbulent bobbing, or large wave distances, a higher frame rate may be desired. Obviously, the higher this is, the more it risks impacting performance.
 <syntaxhighlight lang="cpp">
 if (bUseHighFrameRate) Bobber.FrameRate = 120.0f;
 else Bobber.FrameRate = 30.0f;
@@ Line 82: / Line 86: @@
 The float property Turbulence can be used to get or set the turbulence value that Bobber uses. Applies to all bobbers together. Valid values are 0.0 - 1.0. Default = 0.0. The turbulence value introduces a chaotic element to the animation, to simulate choppy waters or erratic hovering.
 <syntaxhighlight lang="cpp">
 Bobber.Turbulence = 1.0f;
 // The maximum turbulence has been applied.
@@ Line 169: / Line 174: @@
 Cancels all bobers and empties the list. Bobbing entities will be left at their current position.
 <syntaxhighlight lang="cpp">
 Bobber.ClearBobbing();
 // All bobbers have been de-registered. Even "floatyBoi"!
@@ Line 184: / Line 190: @@
 #''string asEntity'' - The entity to check for.
 <syntaxhighlight lang="cpp">
 if (Bobber.IsEntBobbing("barrel1")) DoStuff();
 // The condition succeeds if the entity "barrel1" is a registered bobber.
@@ Line 195: / Line 202: @@
 Writes out the list of bobbing entities as a Debug message with priority 3.
 <br>
 =cNodeBobbing=