Enums

From Frictional Wiki
< HPL3
Revision as of 23:19, 14 August 2020 by TiMan (talk | contribs)
Jump to navigation Jump to search


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.