HPL3/Scripting/Scripting Guide/The Update method - Revision history

TiMan at 10:53, 14 August 2020

2020-08-14T10:53:37Z

2020-08-13T20:57:23Z

2020-08-13T18:25:52Z

Example

2020-08-13T18:24:43Z

Update

2020-08-13T17:37:24Z

Example

2020-08-13T12:14:27Z

2020-08-13T11:56:24Z

2020-08-13T08:40:20Z

Update

2020-08-12T21:13:49Z

Example

2020-08-12T21:12:34Z

Example

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
+{| style="border:0px;" cellspacing="0"
 ==Update==
 <code>Update</code> is one of the most commonly used methods in HPL3. It’s called once per-frame in every script that uses it. Almost anything that needs to be changed or adjusted regularly happens here.
@@ Line 13: / Line 15: @@
+}
 </syntaxhighlight>
+| style="width:0.1%" |
 ===Breakdown===

@@ Line 46: / Line 46: @@
 }}
-{{NavBar|HPL3/Scripting/Scripting_Guide/The OnAction method|The OnAction method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Trigger Areas|Trigger Areas}}
+{{NavBar|HPL3/Scripting/Scripting_Guide/The OnAction method|The OnAction method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Timers|Timers}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 45: / Line 45: @@
 |container=frame
 }}
 {{NavBar|HPL3/Scripting/Scripting_Guide/The OnAction method|The OnAction method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Trigger Areas|Trigger Areas}}

@@ Line 36: / Line 36: @@
 	Light_SetBrightness("PointLight_4", fBrightness); // Apply the brightness
+}
-</syntaxhighlight>{{#ev:youtube|dMH0bHeiRNg}}{{NavBar|HPL3/Scripting/Scripting_Guide/The OnAction method|The OnAction method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Trigger Areas|Trigger Areas}}
+</syntaxhighlight>
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
@@ Line 37: / Line 36: @@
 	Light_SetBrightness("PointLight_4", fBrightness); // Apply the brightness
+}
-</syntaxhighlight>
+</syntaxhighlight>{{#ev:youtube|dMH0bHeiRNg}}{{NavBar|HPL3/Scripting/Scripting_Guide/The OnAction method|The OnAction method|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Trigger Areas|Trigger Areas}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

← Older revision	Revision as of 11:56, 13 August 2020
(No difference)

@@ Line 23: / Line 23: @@
 ===Example===
 If we wanted to increase the brightness of a light based on the distance of the player from that light, we could use the <code>Update</code> method to always update the brightness value at any given time:<syntaxhighlight lang="c++">
 void Update(float afTimeStep)
-−
+{
 	cVector3f vPlayerPos = Player_GetPosition();
 	cVector3f vLightPos = Map_GetLight("PointLight_4").GetLocalPosition();
-	float fDistance = (vLightPos - vPlayerPos).SqrLength(); // Calculate the square root distance of the player and the light.
+	float fDistance = (vLightPos - vPlayerPos).SqrLength(); // Calculate the square root distance of the player from the light.
-	float fCurrentDistanceRatio = vPlayerPos.Length() / fDistance; // Calculate the ratio based on the current distance.
+	float fCurrentDistanceRatio = vPlayerPos.Length() / fDistance; // Calculate the ratio of the total distance and the current position.
 	float fBrightness = cMath_Clamp(fCurrentDistanceRatio, mfMinBrightness, mfMaxBrightness); // Make sure the brightness value is within bounds.
-	Light_SetBrightness("PointLight_4", fBrightness);
+	Light_SetBrightness("PointLight_4", fBrightness); // Apply the brightness
+}
 </syntaxhighlight>

← Older revision		Revision as of 21:12, 12 August 2020
Line 21:		Line 21:

	===Example===		===Example===
		+	If we wanted to increase the brightness of a light based on the distance of the player from that light, we could use the <code>Update</code> method to always update the brightness value at any given time:

−	~~For example, if we wanted to increase a value based on the distance from a certain entity, we could use the Update method to always update the value at any given time.~~
−
−	~~Let’s look at a quick example of what we can achieve with an update function.~~