From 5b5b0c02ddef758ce89a46c1e83614a3a1f951ff Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Matthias=20Mail=C3=A4nder?= Date: Sun, 24 May 2015 09:09:51 +0200 Subject: [PATCH] add trait documentation --- OpenRA.Mods.Common/Traits/Render/RenderBuilding.cs | 1 + OpenRA.Mods.Common/Traits/Render/RenderBuildingSilo.cs | 1 + OpenRA.Mods.Common/Traits/Render/RenderBuildingWall.cs | 1 + OpenRA.Mods.Common/Traits/Render/RenderSimple.cs | 1 + OpenRA.Mods.Common/Traits/Render/RenderSprites.cs | 1 + OpenRA.Mods.Common/Traits/Render/RenderUnit.cs | 1 + OpenRA.Mods.Common/Traits/Render/WithMakeAnimation.cs | 1 + 7 files changed, 7 insertions(+) diff --git a/OpenRA.Mods.Common/Traits/Render/RenderBuilding.cs b/OpenRA.Mods.Common/Traits/Render/RenderBuilding.cs index f5a36c0daf..15612e5588 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderBuilding.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderBuilding.cs @@ -16,6 +16,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Render trait for stationary objects that can be placed from the build palette.")] public class RenderBuildingInfo : RenderSimpleInfo, Requires, IPlaceBuildingDecoration { public readonly bool PauseOnLowPower = false; diff --git a/OpenRA.Mods.Common/Traits/Render/RenderBuildingSilo.cs b/OpenRA.Mods.Common/Traits/Render/RenderBuildingSilo.cs index 4016606988..0652818378 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderBuildingSilo.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderBuildingSilo.cs @@ -15,6 +15,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Render trait for buildings that change the sprite according to the remaining resource storage capacity across all depots.")] class RenderBuildingSiloInfo : RenderBuildingInfo { public override object Create(ActorInitializer init) { return new RenderBuildingSilo(init, this); } diff --git a/OpenRA.Mods.Common/Traits/Render/RenderBuildingWall.cs b/OpenRA.Mods.Common/Traits/Render/RenderBuildingWall.cs index 37315a130b..29160a0e85 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderBuildingWall.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderBuildingWall.cs @@ -16,6 +16,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Render trait for actors that change sprites if neighbors with the same trait are present.")] class RenderBuildingWallInfo : RenderBuildingInfo { public readonly string Type = "wall"; diff --git a/OpenRA.Mods.Common/Traits/Render/RenderSimple.cs b/OpenRA.Mods.Common/Traits/Render/RenderSimple.cs index 26b417d83d..dec1db4a4e 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderSimple.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderSimple.cs @@ -16,6 +16,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Basic render trait for immobile actors.")] public class RenderSimpleInfo : RenderSpritesInfo, IRenderActorPreviewSpritesInfo, IQuantizeBodyOrientationInfo, Requires { public readonly string Sequence = "idle"; diff --git a/OpenRA.Mods.Common/Traits/Render/RenderSprites.cs b/OpenRA.Mods.Common/Traits/Render/RenderSprites.cs index 36f5ee47cd..06970f8f8f 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderSprites.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderSprites.cs @@ -23,6 +23,7 @@ namespace OpenRA.Mods.Common.Traits IEnumerable RenderPreviewSprites(ActorPreviewInitializer init, RenderSpritesInfo rs, string image, int facings, PaletteReference p); } + [Desc("Render trait fundament that won't work without additional With* render traits.")] public class RenderSpritesInfo : IRenderActorPreviewInfo, ITraitInfo, ILegacyEditorRenderInfo { [Desc("The sequence name that defines the actor sprites. Defaults to the actor name.")] diff --git a/OpenRA.Mods.Common/Traits/Render/RenderUnit.cs b/OpenRA.Mods.Common/Traits/Render/RenderUnit.cs index 1abfc5fc05..143daff2a5 100644 --- a/OpenRA.Mods.Common/Traits/Render/RenderUnit.cs +++ b/OpenRA.Mods.Common/Traits/Render/RenderUnit.cs @@ -13,6 +13,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Render trait for non-animated actors that have sprites facing into each direction.")] public class RenderUnitInfo : RenderSimpleInfo, Requires { public override object Create(ActorInitializer init) { return new RenderUnit(init, this); } diff --git a/OpenRA.Mods.Common/Traits/Render/WithMakeAnimation.cs b/OpenRA.Mods.Common/Traits/Render/WithMakeAnimation.cs index c72a2c9c79..367382dc5c 100644 --- a/OpenRA.Mods.Common/Traits/Render/WithMakeAnimation.cs +++ b/OpenRA.Mods.Common/Traits/Render/WithMakeAnimation.cs @@ -17,6 +17,7 @@ using OpenRA.Traits; namespace OpenRA.Mods.Common.Traits { + [Desc("Replaces the sprite during construction.")] public class WithMakeAnimationInfo : ITraitInfo, Requires, Requires { [Desc("Sequence name to use")]