add trait documentation
This commit is contained in:
@@ -16,6 +16,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.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<BuildingInfo>, IPlaceBuildingDecoration
|
public class RenderBuildingInfo : RenderSimpleInfo, Requires<BuildingInfo>, IPlaceBuildingDecoration
|
||||||
{
|
{
|
||||||
public readonly bool PauseOnLowPower = false;
|
public readonly bool PauseOnLowPower = false;
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.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
|
class RenderBuildingSiloInfo : RenderBuildingInfo
|
||||||
{
|
{
|
||||||
public override object Create(ActorInitializer init) { return new RenderBuildingSilo(init, this); }
|
public override object Create(ActorInitializer init) { return new RenderBuildingSilo(init, this); }
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.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
|
class RenderBuildingWallInfo : RenderBuildingInfo
|
||||||
{
|
{
|
||||||
public readonly string Type = "wall";
|
public readonly string Type = "wall";
|
||||||
|
|||||||
@@ -16,6 +16,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.Traits
|
namespace OpenRA.Mods.Common.Traits
|
||||||
{
|
{
|
||||||
|
[Desc("Basic render trait for immobile actors.")]
|
||||||
public class RenderSimpleInfo : RenderSpritesInfo, IRenderActorPreviewSpritesInfo, IQuantizeBodyOrientationInfo, Requires<IBodyOrientationInfo>
|
public class RenderSimpleInfo : RenderSpritesInfo, IRenderActorPreviewSpritesInfo, IQuantizeBodyOrientationInfo, Requires<IBodyOrientationInfo>
|
||||||
{
|
{
|
||||||
public readonly string Sequence = "idle";
|
public readonly string Sequence = "idle";
|
||||||
|
|||||||
@@ -23,6 +23,7 @@ namespace OpenRA.Mods.Common.Traits
|
|||||||
IEnumerable<IActorPreview> RenderPreviewSprites(ActorPreviewInitializer init, RenderSpritesInfo rs, string image, int facings, PaletteReference p);
|
IEnumerable<IActorPreview> 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
|
public class RenderSpritesInfo : IRenderActorPreviewInfo, ITraitInfo, ILegacyEditorRenderInfo
|
||||||
{
|
{
|
||||||
[Desc("The sequence name that defines the actor sprites. Defaults to the actor name.")]
|
[Desc("The sequence name that defines the actor sprites. Defaults to the actor name.")]
|
||||||
|
|||||||
@@ -13,6 +13,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.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<IFacingInfo>
|
public class RenderUnitInfo : RenderSimpleInfo, Requires<IFacingInfo>
|
||||||
{
|
{
|
||||||
public override object Create(ActorInitializer init) { return new RenderUnit(init, this); }
|
public override object Create(ActorInitializer init) { return new RenderUnit(init, this); }
|
||||||
|
|||||||
@@ -17,6 +17,7 @@ using OpenRA.Traits;
|
|||||||
|
|
||||||
namespace OpenRA.Mods.Common.Traits
|
namespace OpenRA.Mods.Common.Traits
|
||||||
{
|
{
|
||||||
|
[Desc("Replaces the sprite during construction.")]
|
||||||
public class WithMakeAnimationInfo : ITraitInfo, Requires<BuildingInfo>, Requires<RenderBuildingInfo>
|
public class WithMakeAnimationInfo : ITraitInfo, Requires<BuildingInfo>, Requires<RenderBuildingInfo>
|
||||||
{
|
{
|
||||||
[Desc("Sequence name to use")]
|
[Desc("Sequence name to use")]
|
||||||
|
|||||||
Reference in New Issue
Block a user