Update PriorityVolumeInfo.cs

This commit is contained in:
Nick 2023-05-26 18:40:24 -04:00 committed by GitHub
parent 3943a0f02a
commit da309ac849
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -11,6 +11,12 @@ namespace NewHorizons.External.Modules.Volumes.VolumeInfos
///
/// Layers separate the priority system. The priority of volumes in one layer will not affect or override volumes in another. The highest priority volume in each layer will stack like normal.
/// The exception is layer 0. A higher-priority volume in layer 0 will override lower-priority volumes in ALL other layers. A lower-priority volume in layer 0 will stack with other layers like normal.
///
/// Ex: A player could be affected by the sun on layer 9 priority 0 and planet gravity on layer 3 priority 2. They would experience the gravity of both volumes since they are on different layers.
/// If there was a zero-g volume on layer 0 priority 1, since it is on layer 0 it will override the gravity from the sun (priority 0 which is less than 1) but they will still feel the
/// gravity of the planet (priority 2 is greater than 1).
///
/// Default value here is 0 which means this volume's priority will be evaluated against all other priority volumes regardless of their layer.
/// </summary>
[DefaultValue(0)] public int layer = 0;