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

Made all traitInfo fields readonly

Browse Source 
This came up while working on the new documentation generation and comparing the results to ORAIDE's own code parser.
This commit is contained in:
penev92
2022-04-25 03:05:30 +03:00
committed by abcdefg30
parent 135823fced
commit 2bac492a65
15 changed files with 27 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
OpenRA.Mods.Common/Traits/Conditions/SpreadsCondition.cs
View File

@@ -28,7 +28,7 @@ namespace OpenRA.Mods.Common.Traits
public readonly string SpreadCondition = "spreading";
[Desc("Time in ticks to wait between spreading further.")]
public int Delay = 5;
public readonly int Delay = 5;
public override object Create(ActorInitializer init) { return new SpreadsCondition(this); }
}

2
OpenRA.Mods.Common/Traits/Crates/CrateAction.cs
View File

@@ -47,7 +47,7 @@ namespace OpenRA.Mods.Common.Traits
[ActorReference]
[Desc("Actor types that this crate action will not occur for.")]
public string[] ExcludedActorTypes = Array.Empty<string>();
public readonly string[] ExcludedActorTypes = Array.Empty<string>();
public override object Create(ActorInitializer init) { return new CrateAction(init.Self, this); }
}

2
OpenRA.Mods.Common/Traits/Crates/ExplodeCrateAction.cs
View File

@@ -19,7 +19,7 @@ namespace OpenRA.Mods.Common.Traits
[WeaponReference]
[FieldLoader.Require]
[Desc("The weapon to fire upon collection.")]
public string Weapon = null;
public readonly string Weapon = null;
public override object Create(ActorInitializer init) { return new ExplodeCrateAction(init.Self, this); }
}

4
OpenRA.Mods.Common/Traits/Crates/GiveCashCrateAction.cs
View File

@@ -17,10 +17,10 @@ namespace OpenRA.Mods.Common.Traits
class GiveCashCrateActionInfo : CrateActionInfo
{
[Desc("Amount of cash to give.")]
public int Amount = 2000;
public readonly int Amount = 2000;
[Desc("Should the collected amount be displayed as a cash tick?")]
public bool UseCashTick = false;
public readonly bool UseCashTick = false;
public override object Create(ActorInitializer init) { return new GiveCashCrateAction(init.Self, this); }
}

2
OpenRA.Mods.Common/Traits/Crates/GiveMcvCrateAction.cs
View File

@@ -17,7 +17,7 @@ namespace OpenRA.Mods.Common.Traits
class GiveMcvCrateActionInfo : GiveUnitCrateActionInfo
{
[Desc("The selection shares to use if the collector has no base.")]
public int NoBaseSelectionShares = 1000;
public readonly int NoBaseSelectionShares = 1000;
public override object Create(ActorInitializer init) { return new GiveMcvCrateAction(init.Self, this); }
}

2
OpenRA.Mods.Common/Traits/MustBeDestroyed.cs
View File

@@ -17,7 +17,7 @@ namespace OpenRA.Mods.Common.Traits
public class MustBeDestroyedInfo : TraitInfo
{
[Desc("In a short game only actors that have this value set to true need to be destroyed.")]
public bool RequiredForShortGame = false;
public readonly bool RequiredForShortGame = false;
public override object Create(ActorInitializer init) { return new MustBeDestroyed(this); }
}

4
OpenRA.Mods.Common/Traits/Player/BaseAttackNotifier.cs
View File

@@ -29,12 +29,12 @@ namespace OpenRA.Mods.Common.Traits
[NotificationReference("Speech")]
[Desc("The audio notification type to play.")]
public string Notification = "BaseAttack";
public readonly string Notification = "BaseAttack";
[NotificationReference("Speech")]
[Desc("The audio notification to play to allies when under attack.",
"Won't play a notification to allies if this is null.")]
public string AllyNotification = null;
public readonly string AllyNotification = null;
public override object Create(ActorInitializer init) { return new BaseAttackNotifier(init.Self, this); }
}

2
OpenRA.Mods.Common/Traits/Player/HarvesterAttackNotifier.cs
View File

@@ -29,7 +29,7 @@ namespace OpenRA.Mods.Common.Traits
[NotificationReference("Speech")]
[Desc("The audio notification type to play.")]
public string Notification = "HarvesterAttack";
public readonly string Notification = "HarvesterAttack";
public override object Create(ActorInitializer init) { return new HarvesterAttackNotifier(init.Self, this); }
}

4
OpenRA.Mods.Common/Traits/Player/MissionObjectives.cs
View File

@@ -265,10 +265,10 @@ namespace OpenRA.Mods.Common.Traits
"Current options for PanelName are 'SKIRMISH_STATS' and 'MISSION_OBJECTIVES'.")]
public class ObjectivesPanelInfo : TraitInfo
{
public string PanelName = null;
public readonly string PanelName = null;
[Desc("in ms")]
public int ExitDelay = 1400;
public readonly int ExitDelay = 1400;
public override object Create(ActorInitializer init) { return new ObjectivesPanel(this); }
}

2
OpenRA.Mods.Common/Traits/Player/PlaceBuilding.cs
View File

@@ -33,7 +33,7 @@ namespace OpenRA.Mods.Common.Traits
public readonly string CannotPlaceNotification = null;
[Desc("Hotkey to toggle between PlaceBuildingVariants when placing a structure.")]
public HotkeyReference ToggleVariantKey = new HotkeyReference();
public readonly HotkeyReference ToggleVariantKey = new HotkeyReference();
public override object Create(ActorInitializer init) { return new PlaceBuilding(this); }
}

6
OpenRA.Mods.Common/Traits/Player/PlayerStatistics.cs
View File

@@ -176,14 +176,14 @@ namespace OpenRA.Mods.Common.Traits
public class UpdatesPlayerStatisticsInfo : TraitInfo
{
[Desc("Add to army value in statistics")]
public bool AddToArmyValue = false;
public readonly bool AddToArmyValue = false;
[Desc("Add to assets value in statistics")]
public bool AddToAssetsValue = true;
public readonly bool AddToAssetsValue = true;
[ActorReference]
[Desc("Count this actor as a different type in the spectator army display.")]
public string OverrideActor = null;
public readonly string OverrideActor = null;
public override object Create(ActorInitializer init) { return new UpdatesPlayerStatistics(this, init.Self); }
}

4
OpenRA.Mods.Common/Traits/ProductionQueueFromSelection.cs
View File

@@ -20,8 +20,8 @@ namespace OpenRA.Mods.Common.Traits
[TraitLocation(SystemActors.World)]
class ProductionQueueFromSelectionInfo : TraitInfo
{
public string ProductionTabsWidget = null;
public string ProductionPaletteWidget = null;
public readonly string ProductionTabsWidget = null;
public readonly string ProductionPaletteWidget = null;
public override object Create(ActorInitializer init) { return new ProductionQueueFromSelection(init.World, this); }
}

2
OpenRA.Mods.Common/Traits/Sellable.cs
View File

@@ -28,7 +28,7 @@ namespace OpenRA.Mods.Common.Traits
[NotificationReference("Speech")]
[Desc("The audio notification type to play.")]
public string Notification = null;
public readonly string Notification = null;
[Desc("Whether to show the cash tick indicators rising from the actor.")]
public readonly bool ShowTicks = true;

2
OpenRA.Mods.Common/Traits/Targetable.cs
View File

@@ -23,7 +23,7 @@ namespace OpenRA.Mods.Common.Traits
public readonly BitSet<TargetableType> TargetTypes;
public BitSet<TargetableType> GetTargetTypes() { return TargetTypes; }
public bool RequiresForceFire = false;
public readonly bool RequiresForceFire = false;
public override object Create(ActorInitializer init) { return new Targetable(this); }
}

14
OpenRA.Mods.D2k/Traits/AttractsWorms.cs
View File

@@ -26,7 +26,7 @@ namespace OpenRA.Mods.D2k.Traits
public readonly WDist Spread = new WDist(3072);
[Desc("Ranges at which each Falloff step is defined. Overrides Spread.")]
public WDist[] Range = null;
public readonly WDist[] Range = null;
public override object Create(ActorInitializer init) { return new AttractsWorms(init, this); }
}
@@ -34,22 +34,22 @@ namespace OpenRA.Mods.D2k.Traits
public class AttractsWorms : ConditionalTrait<AttractsWormsInfo>
{
readonly Actor self;
readonly WDist[] effectiveRange;
public AttractsWorms(ActorInitializer init, AttractsWormsInfo info)
: base(info)
{
self = init.Self;
if (info.Range == null)
info.Range = Exts.MakeArray(info.Falloff.Length, i => i * info.Spread);
effectiveRange = info.Range ?? Exts.MakeArray(info.Falloff.Length, i => i * info.Spread);
}
int GetNoisePercentageAtDistance(int distance)
{
var inner = Info.Range[0].Length;
for (var i = 1; i < Info.Range.Length; i++)
var inner = effectiveRange[0].Length;
for (var i = 1; i < effectiveRange.Length; i++)
{
var outer = Info.Range[i].Length;
var outer = effectiveRange[i].Length;
if (outer > distance)
return int2.Lerp(Info.Falloff[i - 1], Info.Falloff[i], distance - inner, outer - inner);
@@ -68,7 +68,7 @@ namespace OpenRA.Mods.D2k.Traits
var length = distance.Length;
// Actor is too far to hear anything.
if (length > Info.Range[Info.Range.Length - 1].Length)
if (length > effectiveRange[effectiveRange.Length - 1].Length)
return WVec.Zero;
var direction = 1024 * distance / length;