|
| 1 | +#region Copyright & License Information |
| 2 | +/** |
| 3 | + * Copyright (c) The OpenRA Combined Arms Developers (see CREDITS). |
| 4 | + * This file is part of OpenRA Combined Arms, which is free software. |
| 5 | + * It is made available to you under the terms of the GNU General Public License |
| 6 | + * as published by the Free Software Foundation, either version 3 of the License, |
| 7 | + * or (at your option) any later version. For more information, see COPYING. |
| 8 | + */ |
| 9 | +#endregion |
| 10 | + |
| 11 | +using System.Collections.Generic; |
| 12 | +using OpenRA.Activities; |
| 13 | +using OpenRA.Mods.CA.Traits; |
| 14 | +using OpenRA.Mods.Common; |
| 15 | +using OpenRA.Mods.Common.Traits; |
| 16 | +using OpenRA.Primitives; |
| 17 | +using OpenRA.Traits; |
| 18 | + |
| 19 | +namespace OpenRA.Mods.CA.Activities |
| 20 | +{ |
| 21 | + class EnterGarrison : Activity |
| 22 | + { |
| 23 | + enum EnterState { Approaching, Entering, Exiting, Finished } |
| 24 | + |
| 25 | + readonly IMove move; |
| 26 | + readonly Color? targetLineColor; |
| 27 | + readonly Garrisoner garrisoner; |
| 28 | + Target target; |
| 29 | + Target lastVisibleTarget; |
| 30 | + bool useLastVisibleTarget; |
| 31 | + EnterState lastState = EnterState.Approaching; |
| 32 | + |
| 33 | + // EnterGarrison Properties |
| 34 | + Actor enterActor; |
| 35 | + Garrisonable enterGarrison; |
| 36 | + Aircraft enterAircraft; |
| 37 | + |
| 38 | + public EnterGarrison(Actor self, Target target, Color? targetLineColor = null) |
| 39 | + { |
| 40 | + // Base - Enter Properties |
| 41 | + move = self.Trait<IMove>(); |
| 42 | + this.target = target; |
| 43 | + this.targetLineColor = targetLineColor; |
| 44 | + |
| 45 | + // EnterGarrison Properties |
| 46 | + garrisoner = self.Trait<Garrisoner>(); |
| 47 | + } |
| 48 | + |
| 49 | + protected bool TryStartEnter(Actor self, Actor targetActor) |
| 50 | + { |
| 51 | + enterActor = targetActor; |
| 52 | + enterGarrison = targetActor.TraitOrDefault<Garrisonable>(); |
| 53 | + enterAircraft = targetActor.TraitOrDefault<Aircraft>(); |
| 54 | + |
| 55 | + // Make sure we can still enter the transport |
| 56 | + // (but not before, because this may stop the actor in the middle of nowhere) |
| 57 | + if (enterGarrison == null || enterGarrison.IsTraitDisabled || enterGarrison.IsTraitPaused || !garrisoner.Reserve(self, enterGarrison)) |
| 58 | + { |
| 59 | + Cancel(self, true); |
| 60 | + return false; |
| 61 | + } |
| 62 | + |
| 63 | + if (enterAircraft != null && !enterAircraft.AtLandAltitude) |
| 64 | + return false; |
| 65 | + |
| 66 | + return true; |
| 67 | + } |
| 68 | + |
| 69 | + protected void OnCancel() { } |
| 70 | + |
| 71 | + protected void OnEnterComplete(Actor self, Actor targetActor) |
| 72 | + { |
| 73 | + self.World.AddFrameEndTask(w => |
| 74 | + { |
| 75 | + if (self.IsDead) |
| 76 | + return; |
| 77 | + |
| 78 | + // Make sure the target hasn't changed while entering |
| 79 | + // OnEnterComplete is only called if targetActor is alive |
| 80 | + if (targetActor != enterActor) |
| 81 | + return; |
| 82 | + |
| 83 | + if (enterActor.AppearsHostileTo(self)) |
| 84 | + return; |
| 85 | + |
| 86 | + if (!enterGarrison.CanLoad(self)) |
| 87 | + return; |
| 88 | + |
| 89 | + enterGarrison.Load(enterActor, self); |
| 90 | + w.Remove(self); |
| 91 | + }); |
| 92 | + } |
| 93 | + |
| 94 | + // Base Enter Methods Below |
| 95 | + public override bool Tick(Actor self) |
| 96 | + { |
| 97 | + // Update our view of the target |
| 98 | + target = target.Recalculate(self.Owner, out var targetIsHiddenActor); |
| 99 | + |
| 100 | + // Re-acquire the target after change owner has happened. |
| 101 | + if (target.Type == TargetType.Invalid) |
| 102 | + target = Target.FromActor(target.Actor); |
| 103 | + |
| 104 | + if (!targetIsHiddenActor && target.Type == TargetType.Actor) |
| 105 | + lastVisibleTarget = Target.FromTargetPositions(target); |
| 106 | + |
| 107 | + useLastVisibleTarget = targetIsHiddenActor || !target.IsValidFor(self); |
| 108 | + |
| 109 | + // Cancel immediately if the target died while we were entering it |
| 110 | + if (!IsCanceling && useLastVisibleTarget && lastState == EnterState.Entering) |
| 111 | + Cancel(self, true); |
| 112 | + |
| 113 | + // We need to wait for movement to finish before transitioning to |
| 114 | + // the next state or next activity |
| 115 | + if (!TickChild(self)) |
| 116 | + return false; |
| 117 | + |
| 118 | + // Note that lastState refers to what we have just *finished* doing |
| 119 | + switch (lastState) |
| 120 | + { |
| 121 | + case EnterState.Approaching: |
| 122 | + { |
| 123 | + // NOTE: We can safely cancel in this case because we know the |
| 124 | + // actor has finished any in-progress move activities |
| 125 | + if (IsCanceling) |
| 126 | + return true; |
| 127 | + |
| 128 | + // Lost track of the target |
| 129 | + if (useLastVisibleTarget && lastVisibleTarget.Type == TargetType.Invalid) |
| 130 | + return true; |
| 131 | + |
| 132 | + // We are not next to the target - lets fix that |
| 133 | + if (target.Type != TargetType.Invalid && !move.CanEnterTargetNow(self, target)) |
| 134 | + { |
| 135 | + // Target lines are managed by this trait, so we do not pass targetLineColor |
| 136 | + var initialTargetPosition = (useLastVisibleTarget ? lastVisibleTarget : target).CenterPosition; |
| 137 | + QueueChild(move.MoveToTarget(self, target, initialTargetPosition)); |
| 138 | + return false; |
| 139 | + } |
| 140 | + |
| 141 | + // We are next to where we thought the target should be, but it isn't here |
| 142 | + // There's not much more we can do here |
| 143 | + if (useLastVisibleTarget || target.Type != TargetType.Actor) |
| 144 | + return true; |
| 145 | + |
| 146 | + // Are we ready to move into the target? |
| 147 | + if (TryStartEnter(self, target.Actor)) |
| 148 | + { |
| 149 | + lastState = EnterState.Entering; |
| 150 | + QueueChild(move.MoveIntoTarget(self, target)); |
| 151 | + return false; |
| 152 | + } |
| 153 | + |
| 154 | + // Subclasses can cancel the activity during TryStartEnter |
| 155 | + // Return immediately to avoid an extra tick's delay |
| 156 | + if (IsCanceling) |
| 157 | + return true; |
| 158 | + |
| 159 | + return false; |
| 160 | + } |
| 161 | + |
| 162 | + case EnterState.Entering: |
| 163 | + { |
| 164 | + // Re-acquire the target after change owner has happened. |
| 165 | + if (target.Type == TargetType.Invalid) |
| 166 | + target = Target.FromActor(target.Actor); |
| 167 | + |
| 168 | + // Check that we reached the requested position |
| 169 | + var targetPos = target.Positions.PositionClosestTo(self.CenterPosition); |
| 170 | + if (!IsCanceling && self.CenterPosition == targetPos && target.Type == TargetType.Actor) |
| 171 | + OnEnterComplete(self, target.Actor); |
| 172 | + else |
| 173 | + { |
| 174 | + // Need to move again as we have re-aquired a target |
| 175 | + QueueChild(move.MoveToTarget(self, target, targetPos)); |
| 176 | + lastState = EnterState.Approaching; |
| 177 | + return false; |
| 178 | + } |
| 179 | + |
| 180 | + lastState = EnterState.Exiting; |
| 181 | + return false; |
| 182 | + } |
| 183 | + |
| 184 | + case EnterState.Exiting: |
| 185 | + { |
| 186 | + QueueChild(move.ReturnToCell(self)); |
| 187 | + lastState = EnterState.Finished; |
| 188 | + return false; |
| 189 | + } |
| 190 | + } |
| 191 | + |
| 192 | + return true; |
| 193 | + } |
| 194 | + |
| 195 | + public override IEnumerable<TargetLineNode> TargetLineNodes(Actor self) |
| 196 | + { |
| 197 | + if (targetLineColor != null) |
| 198 | + yield return new TargetLineNode(useLastVisibleTarget ? lastVisibleTarget : target, targetLineColor.Value); |
| 199 | + } |
| 200 | + } |
| 201 | +} |
0 commit comments