HPL3/Scripting/Scripting Guide/Enums - Revision history

TiMan at 19:40, 16 August 2020

2020-08-16T19:40:49Z

2020-08-16T10:56:29Z

2020-08-14T22:54:31Z

Using Enums

2020-08-14T22:53:50Z

2020-08-14T22:52:55Z

2020-08-14T22:45:59Z

Declaring Enum Variable

2020-08-14T22:45:31Z

Using Enums

2020-08-14T22:45:15Z

Using Enums

2020-08-14T22:43:30Z

2020-08-14T22:19:42Z

@@ Line 69: / Line 69: @@
 * [[HPL3/Scripting/AngelScript_Fundamentals/Chapter_9_-_Miscellaneous_AngelScript_Features#Enums|Enums - AngelScript]]
-{{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/Conclusion - Basic|Conclusion}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 65: / Line 65: @@
 </syntaxhighlight>
 The last parameter, <code>eMusicPrio_BgAmb</code>, is a value of the enum <code>eMusicPrio</code>.
 {{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}}
 [[Category:HPL3 Scripting]]
 [[Category:English]]

@@ Line 38: / Line 38: @@
 enum WeekDay
+{
-    Day_Sun, // The value here is 0
+    Day_Sun,
-    Day_Mon, // The value here is 1
+    Day_Mon,
-    Day_Tue, // etc
+    Day_Tue,
     Day_Wed,
     Day_Thu,

@@ Line 32: / Line 32: @@
+}
 </syntaxhighlight>
-{| style="border:0px;" cellspacing="0"
+| style="width:0.1%" |
-|- valign="top"
+|}
 ==Using Enums==
 The following example demonstrates use of <code>enum</code> variable:<syntaxhighlight lang="c++">

@@ Line 1: / Line 1: @@
 {{Hpl3ScriptingGuideMenuBasic}}
 {{shortPageTitle}}
+{| style="border:0px;" cellspacing="0"
 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.
@@ Line 30: / Line 32: @@
+}
 </syntaxhighlight>
+{| style="border:0px;" cellspacing="0"
 ==Using Enums==
 The following example demonstrates use of <code>enum</code> variable:<syntaxhighlight lang="c++">

@@ Line 14: / Line 14: @@
 Where:
-*''enum_name'' specifies the enumeration type name.
+*<code>enum_name</code> specifies the enumeration type name.
-*''enumeration'' list is a comma-separated list of identifiers.
+*<code>enumeration</code> list is a comma-separated list of identifiers.
 Each of the symbols in the enumeration list stands for an integer value, one greater than the symbol that precedes it. By default, the value of the first enumeration symbol is 0. For example:

@@ Line 32: / Line 32: @@
 ==Using Enums==
-The following example demonstrates use of enum variable:<syntaxhighlight lang="c++">
+The following example demonstrates use of <code>enum</code> variable:<syntaxhighlight lang="c++">
 enum WeekDay
+{
@@ Line 56: / Line 56: @@
+	}
 </syntaxhighlight>
-When the above code is run, the number 1 will be printed to the screen, because the internal value of Day_Mon is 1.
+When the above code is run, the number 1 will be printed to the screen, because the internal value of <code>Day_Mon</code> is 1.
 ===In HPL3===
 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:<syntaxhighlight lang="c++">

@@ Line 4: / Line 4: @@
 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==
+==Declaring Enum Variable==
 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:<syntaxhighlight lang="c++">
 Music_Play("MyMusicFile.ogg", 1.0f, false, eMusicPrio_BgAmb);