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

From Frictional Wiki
Jump to navigation Jump to search
Line 1: Line 1:
 
{{Hpl3ScriptingGuideMenuBasic}}
 
{{Hpl3ScriptingGuideMenuBasic}}
 
{{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.
 +
 +
== 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 <code>Music_Play<code>. For example:
 +
  
 
{{NavBar|HPL3/Scripting/Scripting_Guide/Local and Global Variables|Local and Global Variables|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Working with Classes|Working with Classes}}
 
{{NavBar|HPL3/Scripting/Scripting_Guide/Local and Global Variables|Local and Global Variables|HPL3/Scripting/HPL3 Scripting Guide|HPL3 Scripting Guide|HPL3/Scripting/Scripting_Guide/Working with Classes|Working with Classes}}

Revision as of 23:07, 14 August 2020


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: