epic/OpenRA
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

embed the previously manually edited outdated documentation

Browse Source 
from https://github.com/OpenRA/OpenRA/wiki/Trait-Documentation
This commit is contained in:
Matthias Mailänder
2013-03-20 21:19:15 +01:00
parent 8226fd21f9
commit c731a7960e
38 changed files with 178 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
OpenRA.Mods.RA/Player/ClassicProductionQueue.cs
View File

@@ -13,13 +13,24 @@ using System.Collections.Generic;
using System.Linq;
using OpenRA.Mods.RA.Buildings;
using OpenRA.Traits;
using OpenRA.FileFormats;
namespace OpenRA.Mods.RA
{
[Desc("Attach this to the world actor (not a building!) to define a new shared build queue.\n" +
"\t# Will only work together with the Production: trait on the actor that actually does the production.\n" +
"\t# You will also want to add PrimaryBuildings: to let the user choose where new units should exit.")]
public class ClassicProductionQueueInfo : ProductionQueueInfo, Requires<TechTreeInfo>, Requires<PowerManagerInfo>, Requires<PlayerResourcesInfo>
{
[Desc("If you build more actors of the same type, \n" +
"\t# the same queue will get it's build time lowered for every actor produced there.")]
public readonly bool SpeedUp = false;
[Desc("Everytime another production building of the same queue is\n" +
"\t# contructed, the build time of all actors in the queue\n" +
"\t#get divided by this value.")]
public readonly int BuildTimeSpeedUpDivisor = 2;
[Desc("You can still build more production buildings\n" +
"\t# than this value, but the build time won't increase further.")]
public readonly int MaxBuildTimeReductionSteps = 6;
public override object Create(ActorInitializer init) { return new ClassicProductionQueue(init.self, this); }

20
OpenRA.Mods.RA/Player/ProductionQueue.cs
View File

@@ -13,21 +13,41 @@ using System.Collections.Generic;
using System.Linq;
using OpenRA.Mods.RA.Buildings;
using OpenRA.Traits;
using OpenRA.FileFormats;
namespace OpenRA.Mods.RA
{
[Desc("Attach this to an actor (usually a building) to let it produce units or construct buildings.\n" +
"\t# If one builds another actor of this type, he will get a separate queue to create two actors\n" +
"\t# at the same time. Will only work together with the Production: trait.")]
public class ProductionQueueInfo : ITraitInfo
{
[Desc("What kind of production will be added (e.g. Building, Infantry, Vehicle, ...)")]
public readonly string Type = null;
[Desc("Group queues from separate buildings together into the same tab.")]
public readonly string Group = null;
[Desc("This value is used to translate the unit cost into build time.")]
public float BuildSpeedModifier = 0.4f;
[Desc("The build time is multiplied with this value on low power.")]
public readonly int LowPowerSlowdown = 3;
[Desc("Notification played when production is complete.\n" +
"\t# The filename of the audio is defined per faction in notifications.yaml.")]
public readonly string ReadyAudio = "UnitReady";
[Desc("Notification played when you can't train another unit\n" +
"\t# when the build limit exceeded or the exit is jammed.\n" +
"\t# The filename of the audio is defined per faction in notifications.yaml.")]
public readonly string BlockedAudio = "NoBuild";
[Desc("Notification played when user clicks on the build palette icon.\n" +
"\t# The filename of the audio is defined per faction in notifications.yaml.")]
public readonly string QueuedAudio = "Training";
[Desc("Notification played when player right-clicks\n" +
"\t# on the build palette icon. The filename of the audio is defined per faction in notifications.yaml.")]
public readonly string OnHoldAudio = "OnHold";
[Desc("Notification played when player right-clicks\n" +
"\t# on a build palette icon that is already on hold.\n" +
"\t# The filename of the audio is defined per faction in notifications.yaml.")]
public readonly string CancelledAudio = "Cancelled";
public virtual object Create(ActorInitializer init) { return new ProductionQueue(init.self, init.self.Owner.PlayerActor, this); }