Category:Enums: Difference between revisions

Latest revision as of 19:20, 4 November 2024

Enums (Enumerated Types) are Value Types which define a list of named constants. These constants names are mapped by the Enum underlying numerical value. For example a simple Enum might be the days of the week:

Values
Name	Value	Description
`Monday`	0	The first day of the week.
`Tuesday`	1	The second day of the week.
`Wednesday`	2	The third day of the week.
`Thursday`	3	The fourth day of the week.
`Friday`	4	The fifth day of the week.
`Saturday`	5	The sixth day of the week.
`Sunday`	6	The seventh day of the week.

Enums are commonly used in Resonite to select between different sets of behavior on Components or in ProtoFlux. In an Inspector they are shown by their name, with the ability to switch between the possible values.

Examples

In the Tween Node, there is an input called CurvePreset which defines the type of Curve a Tween operation follows. By altering this Enum, you can change usually how smooth a Tween operation is.

In ProtoFlux

ProtoFlux has nodes for working with enum values, such as converting between names and numeric values.

Notes

Enums may have multiple different names for the same value (example: SessionAccessLevel)

Pages in category "Enums"

The following 158 pages are in this category, out of 158 total.

A

B

C

D

E

F

H

I

K

L

M

N

R

T

U

V

W

Z

@@ Line 1: / Line 1: @@
-Enums(Enumerated Types) are Value Types which define a list of constants. These constants are mapped inside an Enum to an underlying numerical value. For example a simple Enum might be the days of the week:
+Enums (Enumerated Types) are [[:Category:Type:Value|Value Types]] which define a list of named constants. These constants names are mapped by the Enum underlying numerical value. For example a simple Enum might be the days of the week:
-* Monday - 0
+{{Table EnumValues
-* Tuesday - 1
+|Monday|0|The first day of the week.
-* Wednesday - 2
+|Tuesday|1|The second day of the week.
-* Thursday - 3
+|Wednesday|2|The third day of the week.
-* Friday - 4
+|Thursday|3|The fourth day of the week.
-* Saturday - 5
+|Friday|4|The fifth day of the week.
-* Sunday - 6
+|Saturday|5|The sixth day of the week.
+|Sunday|6|The seventh day of the week.
+}}
-Enums are useful when you want a defined set of behavior for a system to follow or when you want two components of a system to speak a common language.
+Enums are commonly used in [[Resonite]] to select between different sets of behavior on [[Component]]s or in [[ProtoFlux]]. In an [[Inspector]] they are shown by their name, with the ability to switch between the possible values.
-In Resonite you will mostly come across Enums when you are dealing with certain ProtoFlux nodes or Components which have sets of predefined behavior which can be altered or changed by changing a value of an Enum.
+== Examples ==
-For example, In the [[Tween Value (ProtoFlux)|Tween Node]], there is an input called [[Type:CurvePreset|CurvePreset]] which defines the type of Curve a Tween operation follows. By altering this Enum, you can change usually how smooth a Tween operation is.
+In the [[ProtoFlux:Tween Value|Tween Node]], there is an input called [[Type:CurvePreset|CurvePreset]] which defines the type of Curve a Tween operation follows. By altering this Enum, you can change usually how smooth a Tween operation is.
+== In ProtoFlux ==
+[[ProtoFlux]] has [[:Category:ProtoFlux:Enums|nodes for working with enum values]], such as converting between names and numeric values.
+== Notes ==
+Enums may have multiple different names for the same value (example: [[Type:SessionAccessLevel|SessionAccessLevel]])
+== See Also ==
+* [[:Category:Components With Nested Enums|Components With Nested Enums]] for enums that are a [[:Category:Components With Nested Types|nested type]] of a [[Component]].
+* [https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/enum Enumeration types (C# reference)]
 [[Category:Type]]
@@ Line 28: / Line 43: @@
 * [[Type:Culling|Culling]]
 * [[Type:HeadOutputDevice|HeadOutputDevice]]
-* [[Type:HttpStatusCode|HttpStatusCode]]
-* [[Type:Key|Key]]
 * [[Type:LightType|LightType]]
 * [[Type:SessionAccountLevel|SessionAccountLevel]]