m Added two types |
m trailing whitespace grrr |
||
(6 intermediate revisions by 5 users not shown) | |||
Line 1: | Line 1: | ||
<languages /> | |||
<translate> | |||
'''Enums''' (short for enumerated types) are [[value types]] that define a list of named constants. These constant names are mapped to underlying [[Type:Int|integer]] values. | |||
</translate> | |||
<translate> | |||
As a general example, a simple enum might be the days of the week: | |||
</translate> | |||
{{Table EnumValues | |||
|<translate>Monday</translate>|0|<translate>The first day of the week.</translate> | |||
|<translate>Tuesday</translate>|1|<translate>The second day of the week.</translate> | |||
|<translate>Wednesday</translate>|2|<translate>The third day of the week.</translate> | |||
|<translate>Thursday</translate>|3|<translate>The fourth day of the week.</translate> | |||
|<translate>Friday</translate>|4|<translate>The fifth day of the week.</translate> | |||
|<translate>Saturday</translate>|5|<translate>The sixth day of the week.</translate> | |||
|<translate>Sunday</translate>|6|<translate>The seventh day of the week.</translate> | |||
}} | |||
<translate> | |||
Enums are commonly used in [[Resonite]] to select between different sets of behavior on [[components]] or in [[ProtoFlux]]. In an [[inspector]], enums are shown by their name along with the ability to switch between the defined values. | |||
</translate> | |||
[[Category:Type]] | == <translate>Examples</translate> == | ||
<translate> | |||
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. | |||
</translate> | |||
== <translate>In ProtoFlux</translate> == | |||
<translate>[[ProtoFlux]] has [[:Category:ProtoFlux:Enums|nodes for working with enum values]], such as converting between names and numeric values.</translate> | |||
== <translate>Notes</translate> == | |||
<translate> | |||
Enums may have multiple different names for the same value (example: [[Type:SessionAccessLevel|SessionAccessLevel]]) | |||
</translate> | |||
== <translate>See Also</translate> == | |||
* [[:Category:Components With Nested Enums]] <translate>for enums that are a [[:Category:Components With Nested Types|nested type]] of a [[Component]].</translate> | |||
* [https://learn.microsoft.com/en-us/dotnet/csharp/language-reference/builtin-types/enum <translate>Microsoft documentation for C# enums.</translate>] | |||
[[Category:Type]] | |||
<!-- | <!-- | ||
TODO: | TODO: | ||
Line 26: | Line 53: | ||
* [[Type:CameraPositioningMode|CameraPositioningMode]] | * [[Type:CameraPositioningMode|CameraPositioningMode]] | ||
* [[Type:Clear|Clear]] | * [[Type:Clear|Clear]] | ||
* [[Type:Culling|Culling]] | * [[Type:Culling|Culling]] | ||
* [[Type:HeadOutputDevice|HeadOutputDevice]] | * [[Type:HeadOutputDevice|HeadOutputDevice]] | ||
* [[Type:LightType|LightType]] | * [[Type:LightType|LightType]] | ||
* [[Type:SessionAccountLevel|SessionAccountLevel]] | * [[Type:SessionAccountLevel|SessionAccountLevel]] |
Latest revision as of 21:06, 30 January 2025
Enums (short for enumerated types) are value types that define a list of named constants. These constant names are mapped to underlying integer values.
As a general example, a simple enum might be the days of the week:
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, enums are shown by their name along with the ability to switch between the defined 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)
See Also
- Category:Components With Nested Enums for enums that are a nested type of a Component.
- Microsoft documentation for C# enums.
Pages in category "Enums"
The following 161 pages are in this category, out of 161 total.
A
C
- Type:CameraClearMode
- Type:CameraPositioningMode
- Type:CharacterControllerParameter
- Type:CloudProfile
- Type:CloudVariableChangeMode
- Type:ColliderType
- Type:ColorProfileRequirement
- Type:ComponentHandling
- Type:CompoundZeroHandling
- Type:Culling
- Type:Chirality
- Type:ColorMask
- Type:ColorProfile
- Type:CurvePreset
D
E
F
H
L
M
P
- Type:PanoramicProjection
- Type:ParticleAlignment
- Type:ParticleAnimationType
- Type:ParticleTrailMode
- Type:ParticleTrailTextureMode
- Type:PBR TextureFormat
- Type:PermissionState
- Type:PermissionViolationAction
- Type:PhotoEncodeFormat
- Type:PhysicsScalingMode
- Type:Platform
- Type:PointerType
- Type:PointProjection
- Type:PositionType
- Type:PrimaryLocomotionController
- Type:Primitive
- Type:Priority
- Type:ProgressStage
- Type:PropertyState
- Type:PlaybackAction
S
- Type:SampleRateMode
- Type:SaveType
- Type:ScreenshotType
- Type:SensationClass
- Type:SessionAccessLevel
- Type:Shading
- Type:ShadowCascadeMode
- Type:ShadowCastMode
- Type:ShadowResolutionMode
- Type:ShadowType
- Type:SidewaysMovementMode
- Type:SimulationType
- Type:SizeFit
- Type:SkinWeightMode
- Type:StaticCameraType
- Type:SteamChannel
- Type:SteamCloseReason
- Type:StereoLayout
- Type:StringComparison
- Type:ShoulderRotationMode
- Type:SkinnedBounds
- Type:StencilComparison
- Type:StencilOperation