Convert DisposalUnitVisualizer to VisualizerSystem (#13637)

This commit is contained in:
eoineoineoin
2023-02-03 22:26:50 +00:00
committed by GitHub
parent efd689d98e
commit be94048932
9 changed files with 386 additions and 394 deletions

View File

@@ -1,6 +1,6 @@
using Content.Shared.Disposal.Components;
using Content.Shared.DragDrop;
using Robust.Shared.GameObjects;
using Content.Shared.Disposal.Components;
using Robust.Client.Animations;
using Robust.Shared.Audio;
namespace Content.Client.Disposal.Components
{
@@ -8,6 +8,11 @@ namespace Content.Client.Disposal.Components
[ComponentReference(typeof(SharedDisposalUnitComponent))]
public sealed class DisposalUnitComponent : SharedDisposalUnitComponent
{
[DataField("flushSound")]
public readonly SoundSpecifier? FlushSound;
public Animation FlushAnimation = default!;
public DisposalUnitBoundUserInterfaceState? UiState;
public override void HandleComponentState(ComponentState? curState, ComponentState? nextState)

View File

@@ -1,59 +1,186 @@
using System.Collections.Generic;
using Content.Client.Disposal.Components;
using Content.Client.Disposal.UI;
using Content.Shared.Disposal;
using Robust.Client.GameObjects;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using Robust.Client.Animations;
using static Content.Shared.Disposal.Components.SharedDisposalUnitComponent;
namespace Content.Client.Disposal.Systems
namespace Content.Client.Disposal.Systems;
public sealed class DisposalUnitSystem : SharedDisposalUnitSystem
{
public sealed class DisposalUnitSystem : SharedDisposalUnitSystem
[Dependency] private readonly AppearanceSystem AppearanceSystem = default!;
[Dependency] private readonly AnimationPlayerSystem AnimationSystem = default!;
[Dependency] private readonly SharedAudioSystem SoundSystem = default!;
private const string AnimationKey = "disposal_unit_animation";
private List<EntityUid> PressuringDisposals = new();
public override void Initialize()
{
public List<DisposalUnitComponent> PressuringDisposals = new();
base.Initialize();
public void UpdateActive(DisposalUnitComponent component, bool active)
SubscribeLocalEvent<DisposalUnitComponent, ComponentInit>(OnComponentInit);
SubscribeLocalEvent<DisposalUnitComponent, AppearanceChangeEvent>(OnAppearanceChange);
}
public void UpdateActive(EntityUid disposalEntity, bool active)
{
if (active)
{
if (active)
{
if (!PressuringDisposals.Contains(component))
PressuringDisposals.Add(component);
}
else
{
PressuringDisposals.Remove(component);
}
if (!PressuringDisposals.Contains(disposalEntity))
PressuringDisposals.Add(disposalEntity);
}
public override void FrameUpdate(float frameTime)
else
{
base.FrameUpdate(frameTime);
for (var i = PressuringDisposals.Count - 1; i >= 0; i--)
{
var comp = PressuringDisposals[i];
if (!UpdateInterface(comp)) continue;
PressuringDisposals.RemoveAt(i);
}
}
private bool UpdateInterface(DisposalUnitComponent component)
{
if (component.Deleted) return true;
if (!EntityManager.TryGetComponent(component.Owner, out ClientUserInterfaceComponent? userInterface)) return true;
var state = component.UiState;
if (state == null) return true;
foreach (var inter in userInterface.Interfaces)
{
if (inter is DisposalUnitBoundUserInterface boundInterface)
{
return boundInterface.UpdateWindowState(state) != false;
}
}
return true;
PressuringDisposals.Remove(disposalEntity);
}
}
public override void FrameUpdate(float frameTime)
{
base.FrameUpdate(frameTime);
for (var i = PressuringDisposals.Count - 1; i >= 0; i--)
{
var disposal = PressuringDisposals[i];
if (!UpdateInterface(disposal))
continue;
PressuringDisposals.RemoveAt(i);
}
}
private bool UpdateInterface(EntityUid disposalUnit)
{
if (!TryComp(disposalUnit, out DisposalUnitComponent? component) || component.Deleted)
return true;
if (component.Deleted)
return true;
if (!TryComp(disposalUnit, out ClientUserInterfaceComponent? userInterface))
return true;
var state = component.UiState;
if (state == null)
return true;
foreach (var inter in userInterface.Interfaces)
{
if (inter is DisposalUnitBoundUserInterface boundInterface)
{
return boundInterface.UpdateWindowState(state) != false;
}
}
return true;
}
private void OnComponentInit(EntityUid uid, DisposalUnitComponent disposalUnit, ComponentInit args)
{
if (!TryComp<SpriteComponent>(uid, out var sprite))
return;
if(!sprite.LayerMapTryGet(DisposalUnitVisualLayers.Base, out var baseLayerIdx))
return; // Couldn't find the "normal" layer to return to after flush animation
if(!sprite.LayerMapTryGet(DisposalUnitVisualLayers.BaseFlush, out var flushLayerIdx))
return; // Couldn't find the flush animation layer
var originalBaseState = sprite.LayerGetState(baseLayerIdx);
var flushState = sprite.LayerGetState(flushLayerIdx);
// Setup the flush animation to play
disposalUnit.FlushAnimation = new Animation {
Length = TimeSpan.FromSeconds(disposalUnit.FlushTime),
AnimationTracks = {
new AnimationTrackSpriteFlick {
LayerKey = DisposalUnitVisualLayers.BaseFlush,
KeyFrames = {
// Play the flush animation
new AnimationTrackSpriteFlick.KeyFrame(flushState, 0),
// Return to base state (though, depending on how the unit is
// configured we might get an appearence change event telling
// us to go to charging state)
new AnimationTrackSpriteFlick.KeyFrame(originalBaseState, disposalUnit.FlushTime)
}
},
}
};
if (disposalUnit.FlushSound != null)
{
disposalUnit.FlushAnimation.AnimationTracks.Add(
new AnimationTrackPlaySound {
KeyFrames = {
new AnimationTrackPlaySound.KeyFrame(SoundSystem.GetSound(disposalUnit.FlushSound), 0)
}
});
}
EnsureComp<AnimationPlayerComponent>(uid);
UpdateState(uid, disposalUnit, sprite);
}
private void OnAppearanceChange(EntityUid uid, DisposalUnitComponent unit, ref AppearanceChangeEvent args)
{
if (args.Sprite == null)
{
return;
}
UpdateState(uid, unit, args.Sprite);
}
// Update visuals and tick animation
private void UpdateState(EntityUid uid, DisposalUnitComponent unit, SpriteComponent sprite)
{
if (!AppearanceSystem.TryGetData<VisualState>(uid, Visuals.VisualState, out var state))
{
return;
}
sprite.LayerSetVisible(DisposalUnitVisualLayers.Unanchored, state == VisualState.UnAnchored);
sprite.LayerSetVisible(DisposalUnitVisualLayers.Base, state == VisualState.Anchored);
sprite.LayerSetVisible(DisposalUnitVisualLayers.BaseCharging, state == VisualState.Charging);
sprite.LayerSetVisible(DisposalUnitVisualLayers.BaseFlush, state == VisualState.Flushing);
if (state == VisualState.Flushing)
{
if (!AnimationSystem.HasRunningAnimation(uid, AnimationKey))
{
AnimationSystem.Play(uid, unit.FlushAnimation, AnimationKey);
}
}
if (!AppearanceSystem.TryGetData<HandleState>(uid, Visuals.Handle, out var handleState))
{
handleState = HandleState.Normal;
}
sprite.LayerSetVisible(DisposalUnitVisualLayers.OverlayEngaged, handleState != HandleState.Normal);
if (!AppearanceSystem.TryGetData<LightStates>(uid, Visuals.Light, out var lightState))
{
lightState = LightStates.Off;
}
sprite.LayerSetVisible(DisposalUnitVisualLayers.OverlayCharging,
(lightState & LightStates.Charging) != 0);
sprite.LayerSetVisible(DisposalUnitVisualLayers.OverlayReady,
(lightState & LightStates.Ready) != 0);
sprite.LayerSetVisible(DisposalUnitVisualLayers.OverlayFull,
(lightState & LightStates.Full) != 0);
}
}
public enum DisposalUnitVisualLayers : byte
{
Unanchored,
Base,
BaseCharging,
BaseFlush,
OverlayCharging,
OverlayReady,
OverlayFull,
OverlayEngaged
}

View File

@@ -1,12 +1,9 @@
using Content.Client.Disposal.Components;
using Content.Client.Disposal.Components;
using Content.Client.Disposal.Systems;
using Content.Shared.Disposal;
using JetBrains.Annotations;
using Robust.Client.GameObjects;
using Robust.Client.UserInterface.Controls;
using Robust.Client.UserInterface.CustomControls;
using Robust.Shared.GameObjects;
using Robust.Shared.IoC;
using static Content.Shared.Disposal.Components.SharedDisposalUnitComponent;
namespace Content.Client.Disposal.UI
@@ -17,11 +14,14 @@ namespace Content.Client.Disposal.UI
[UsedImplicitly]
public sealed class DisposalUnitBoundUserInterface : BoundUserInterface
{
[Dependency] private readonly IEntityManager _entityManager = default!;
public MailingUnitWindow? MailingUnitWindow;
public DisposalUnitWindow? DisposalUnitWindow;
public DisposalUnitBoundUserInterface(ClientUserInterfaceComponent owner, Enum uiKey) : base(owner, uiKey)
{
IoCManager.InjectDependencies(this);
}
private void ButtonPressed(UiButton button)
@@ -76,7 +76,9 @@ namespace Content.Client.Disposal.UI
return;
}
if (!IoCManager.Resolve<IEntityManager>().TryGetComponent(Owner.Owner, out DisposalUnitComponent? component)) return;
var entityId = Owner.Owner;
if (!_entityManager.TryGetComponent(entityId, out DisposalUnitComponent? component))
return;
switch (state)
{
@@ -91,7 +93,7 @@ namespace Content.Client.Disposal.UI
break;
}
EntitySystem.Get<DisposalUnitSystem>().UpdateActive(component, true);
_entityManager.System<DisposalUnitSystem>().UpdateActive(entityId, true);
}
protected override void Dispose(bool disposing)

View File

@@ -1,169 +0,0 @@
using JetBrains.Annotations;
using Robust.Client.Animations;
using Robust.Client.GameObjects;
using Robust.Shared.Audio;
using Robust.Shared.Serialization;
using static Content.Shared.Disposal.Components.SharedDisposalUnitComponent;
namespace Content.Client.Disposal.Visualizers
{
[UsedImplicitly]
public sealed class DisposalUnitVisualizer : AppearanceVisualizer, ISerializationHooks
{
private const string AnimationKey = "disposal_unit_animation";
[DataField("state_anchored", required: true)]
private string? _stateAnchored;
[DataField("state_unanchored", required: true)]
private string? _stateUnAnchored;
[DataField("state_charging", required: true)]
private string? _stateCharging;
[DataField("overlay_charging", required: true)]
private string? _overlayCharging;
[DataField("overlay_ready", required: true)]
private string? _overlayReady;
[DataField("overlay_full", required: true)]
private string? _overlayFull;
[DataField("overlay_engaged", required: true)]
private string? _overlayEngaged;
[DataField("state_flush", required: true)]
private string? _stateFlush;
[DataField("flush_sound", required: true)]
private SoundSpecifier _flushSound = default!;
[DataField("flush_time", required: true)]
private float _flushTime;
private Animation _flushAnimation = default!;
void ISerializationHooks.AfterDeserialization()
{
_flushAnimation = new Animation {Length = TimeSpan.FromSeconds(_flushTime)};
var flick = new AnimationTrackSpriteFlick();
_flushAnimation.AnimationTracks.Add(flick);
flick.LayerKey = DisposalUnitVisualLayers.Base;
flick.KeyFrames.Add(new AnimationTrackSpriteFlick.KeyFrame(_stateFlush, 0));
var sound = new AnimationTrackPlaySound();
_flushAnimation.AnimationTracks.Add(sound);
sound.KeyFrames.Add(new AnimationTrackPlaySound.KeyFrame(_flushSound.GetSound(), 0));
}
private void ChangeState(AppearanceComponent appearance)
{
if (!appearance.TryGetData(Visuals.VisualState, out VisualState state))
{
return;
}
var entities = IoCManager.Resolve<IEntityManager>();
if (!entities.TryGetComponent(appearance.Owner, out SpriteComponent? sprite))
{
return;
}
switch (state)
{
case VisualState.UnAnchored:
sprite.LayerSetState(DisposalUnitVisualLayers.Base, _stateUnAnchored);
break;
case VisualState.Anchored:
sprite.LayerSetState(DisposalUnitVisualLayers.Base, _stateAnchored);
break;
case VisualState.Charging:
sprite.LayerSetState(DisposalUnitVisualLayers.Base, _stateCharging);
break;
case VisualState.Flushing:
sprite.LayerSetState(DisposalUnitVisualLayers.Base, _stateAnchored);
var animPlayer = entities.GetComponent<AnimationPlayerComponent>(appearance.Owner);
if (!animPlayer.HasRunningAnimation(AnimationKey))
{
animPlayer.Play(_flushAnimation, AnimationKey);
}
break;
default:
throw new ArgumentOutOfRangeException();
}
if (!appearance.TryGetData(Visuals.Handle, out HandleState handleState))
{
handleState = HandleState.Normal;
}
sprite.LayerSetVisible(DisposalUnitVisualLayers.Handle, handleState != HandleState.Normal);
switch (handleState)
{
case HandleState.Normal:
break;
case HandleState.Engaged:
sprite.LayerSetState(DisposalUnitVisualLayers.Handle, _overlayEngaged);
break;
default:
throw new ArgumentOutOfRangeException();
}
if (!appearance.TryGetData(Visuals.Light, out LightState lightState))
{
lightState = LightState.Off;
}
sprite.LayerSetVisible(DisposalUnitVisualLayers.Light, lightState != LightState.Off);
switch (lightState)
{
case LightState.Off:
break;
case LightState.Charging:
sprite.LayerSetState(DisposalUnitVisualLayers.Light, _overlayCharging);
break;
case LightState.Full:
sprite.LayerSetState(DisposalUnitVisualLayers.Light, _overlayFull);
break;
case LightState.Ready:
sprite.LayerSetState(DisposalUnitVisualLayers.Light, _overlayReady);
break;
default:
throw new ArgumentOutOfRangeException();
}
}
[Obsolete("Subscribe to your component being initialised instead.")]
public override void InitializeEntity(EntityUid entity)
{
base.InitializeEntity(entity);
var entities = IoCManager.Resolve<IEntityManager>();
entities.EnsureComponent<AnimationPlayerComponent>(entity);
var appearance = entities.EnsureComponent<ClientAppearanceComponent>(entity);
ChangeState(appearance);
}
[Obsolete("Subscribe to AppearanceChangeEvent instead.")]
public override void OnChangeData(AppearanceComponent component)
{
base.OnChangeData(component);
ChangeState(component);
}
}
public enum DisposalUnitVisualLayers : byte
{
Base,
Handle,
Light
}
}