Difference between revisions of "HPL3/Scripting/Scripting Guide/The Update method"

From Frictional Wiki
Jump to navigation Jump to search
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.
 
  
  

Revision as of 22:12, 12 August 2020

Wip icon.png

This article is actively undergoing a major edit.
As a courtesy, please do not edit this article while this message is displayed. If this page has not been edited for at least several hours to a few days, please remove this template. This message is intended to help reduce edit conflicts; please remove it between editing sessions to allow others to edit the page.

The user who added this notice will be listed in its edit history should you wish to contact them.

  1. The Basics - Introduction
  2. What is scripting in HPL3?
  3. Setting up CodeLite - Scripting Tool
  4. Scripting Workflow and Structure
  5. Hello World
  6. Calling Functions and Function Callbacks
  7. Helper Files
  8. The OnAction method
  9. The Update method
  10. Timers
  11. Sequences
  12. Local and Global Variables
  13. Enums
  14. Conclusion


Update

Update 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.

The Update method gets called on a fixed timeline and has the same time between calls. Immediately after Update is called, any necessary calculations are made, such as physics or dynamic value changes. Anything that affects rigid bodies, meaning a physics object, should be executed in this method.

Below is the default code in a map script file for Update:

void Update(float afTimeStep) 
{
}

Breakdown

  • afTimeStep represents the time (in seconds) which takes the function to get called. It is called every frame, and the game can run up to 60 frames per seconds. Therefore, the value of afTimeStep will almost always be 0.0167 seconds (60 fps in seconds).

However, we can also use it to calculate different things that aren’t related to physics.

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 Update method to always update the brightness value at any given time:


Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Scripting/Scripting_Guide/The_Update_method&oldid=4219"