Difference between revisions of "HPL3/Scripting/Scripting Guide/Working with Classes"

From Frictional Wiki
Jump to navigation Jump to search
Line 4: Line 4:
 
|- valign="top"
 
|- valign="top"
 
| style="padding-right:0.2em" |
 
| style="padding-right:0.2em" |
−
Classes in HPL3 are generally used to perform thins that 
+
HPL3 Supports class usage 
−
 
 
−
== Uses in HPL3 ==
 
−
{{tip|As a general rule of thumb: '''Use HPL3 classes only when you cannot find in the helper files what you are looking for. They merely offer some extended functionality which may not be found in the helper files.'''}}
 
  
 +
{{tip|As a general rule of thumb: '''Use HPL3 classes only when you cannot find what you are looking for in the helper files or the scripting api. They merely offer some extended functionality which may not be found in the helper files.'''}}
 +
===Example===
 +
Let's say you want to change the position of an entity through script. Usually, in order to perform something on entities, you would use a function that starts with <code>Entity_</code>. However, some things cannot be done through helper functions. The class <code>iLuxEntity</code> provides additional useful functionalities for entities. In order to retrieve a class object of an entity, you need to use <code>Map_GetEntity</code>:
 
<syntaxhighlight lang="c++">
 
<syntaxhighlight lang="c++">
 
void MoveEntityPosition()
 
void MoveEntityPosition()

Revision as of 19:14, 16 August 2020

  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

HPL3 Supports class usage

Icon tip.png Tip: As a general rule of thumb: Use HPL3 classes only when you cannot find what you are looking for in the helper files or the scripting api. They merely offer some extended functionality which may not be found in the helper files.

Example

Let's say you want to change the position of an entity through script. Usually, in order to perform something on entities, you would use a function that starts with Entity_. However, some things cannot be done through helper functions. The class iLuxEntity provides additional useful functionalities for entities. In order to retrieve a class object of an entity, you need to use Map_GetEntity: 

void MoveEntityPosition()
{
	// Create a 3D Vector and save the position data into it
    // X: 55, Y: 5, Z: 25
	cVector3f positionData = cVector3f(55, 5, 25);
		
	iLuxEntity@ entity = Map_GetEntity("MyEntity"); // Get the iLuxEntity object of our entity in the map
	entity.SetPosition(positionData); // Set the new position of the entity
}

Every technical feature in HPL3 has a corresponding class to it (Lights, Billboards, Materials, GUI, etc), which makes scripting in HPL3 very flexible and allows you do modify anything through script.

See Also

← Enums
Retrieved from "https://wiki.frictionalgames.com/page?title=HPL3/Scripting/Scripting_Guide/Working_with_Classes&oldid=4632"