Difference between revisions of "HPL3/Scripting/Scripting Guide/Enums"

From Frictional Wiki
Jump to navigation Jump to search
Line 2: Line 2:
 
{{shortPageTitle}}
 
{{shortPageTitle}}
  
−
Enum is a user defined datatype in HPL3. It is used to assign names to the integral constants which makes a script easy to read and maintain. The keyword “enum” is used to declare an enumeration.
+
Enum is a user defined datatype in HPL3. It is used to assign names to the integral constants which makes a script easy to read and maintain. The keyword <code>enum</code> is used to declare an enumeration.
  
 
==How to Use Enums==
 
==How to Use Enums==

Revision as of 23:19, 14 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


Enum is a user defined datatype in HPL3. It is used to assign names to the integral constants which makes a script easy to read and maintain. The keyword enum is used to declare an enumeration.

How to Use Enums

Enums are mostly required as a parameter for existing HPL3 functions. One of the most common function which uses an enum is Music_Play. For example:

Music_Play("MyMusicFile.ogg", 1.0f, false, eMusicPrio_BgAmb);

The last parameter, eMusicPrio_BgAmb, is a value of the enum eMusicPrio.

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