Adds a light code comment to StorageFillComponent.cs

This commit is contained in:
SweptWasTaken
2021-05-21 11:56:15 -07:00
parent d97dd4400d
commit 9954764c58

View File

@@ -66,7 +66,27 @@ namespace Content.Server.GameObjects.Components.Items.Storage
[DataField("prob")]
public float SpawnProbability;
/// <summary>
/// orGroup signifies to pick between multiple entities on spawn.
///
/// <example>
/// <para>To define an orGroup in a StorageFill component
/// you need to add it to the entities you want to choose between.
/// </para>
/// <code>
/// - type: StorageFill
/// contents:
/// - name: X
/// - name: Y
/// orGroup: YOrZ
/// - name: Z
/// orGroup: YOrZ
///
///
///
/// </code>
/// </example>
/// </summary>
[DataField("orGroup")]
public string GroupId;