tommy/tbd-station-14
2
1
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Implement machine linking (#1784)

Browse Source 
* Implement machine linking

* Cleanup and rename Signals

* Implement signal button

* Add machine linking signal mapping

* Fix signallink command help

* Add localization to signal linking and allow infinite range

* Add feedback for when a transmitter is not connected to any receivers

Refactor PopupMessage to use the entity extension
Refactor dependencies to not have to disable warnings
This commit is contained in:
ShadowCommander
2020-08-29 03:33:42 -07:00
committed by GitHub
parent f3315feba1
commit aa66aa2286
16 changed files with 701 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
Content.Server/GameObjects/Components/MachineLinking/ISignalReceiver.cs Normal file
View File

@@ -0,0 +1,14 @@
namespace Content.Server.GameObjects.Components.MachineLinking
{
public interface ISignalReceiver
{
void TriggerSignal(SignalState state);
}
public enum SignalState
{
On,
Off,
Toggle
}
}

40
Content.Server/GameObjects/Components/MachineLinking/SignalButtonComponent.cs Normal file
View File

@@ -0,0 +1,40 @@
using Content.Shared.Interfaces;
using Content.Shared.Interfaces.GameObjects.Components;
using Robust.Shared.GameObjects;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Localization;
namespace Content.Server.GameObjects.Components.MachineLinking
{
[RegisterComponent]
public class SignalButtonComponent : Component, IActivate, IInteractHand
{
public override string Name => "SignalButton";
public void Activate(ActivateEventArgs eventArgs)
{
TransmitSignal(eventArgs.User);
}
public bool InteractHand(InteractHandEventArgs eventArgs)
{
TransmitSignal(eventArgs.User);
return true;
}
private void TransmitSignal(IEntity user)
{
if (!Owner.TryGetComponent<SignalTransmitterComponent>(out var transmitter))
{
return;
}
if (transmitter.TransmitSignal(user, SignalState.Toggle))
{
// Since the button doesn't have an animation, I'm going to use a popup message
Owner.PopupMessage(user, Loc.GetString("Click."));
}
}
}
}

21
Content.Server/GameObjects/Components/MachineLinking/SignalLinkerComponent.cs Normal file
View File

@@ -0,0 +1,21 @@
using Robust.Shared.GameObjects;
using Robust.Shared.ViewVariables;
namespace Content.Server.GameObjects.Components.MachineLinking
{
[RegisterComponent]
public class SignalLinkerComponent : Component
{
public override string Name => "SignalLinker";
[ViewVariables]
public SignalTransmitterComponent Link { get; set; }
public override void Initialize()
{
base.Initialize();
Link = null;
}
}
}

118
Content.Server/GameObjects/Components/MachineLinking/SignalReceiverComponent.cs Normal file
View File

@@ -0,0 +1,118 @@
using Content.Server.GameObjects.Components.Interactable;
using Content.Shared.GameObjects.Components.Interactable;
using Content.Shared.Interfaces;
using Content.Shared.Interfaces.GameObjects.Components;
using Robust.Shared.GameObjects;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Interfaces.Map;
using Robust.Shared.IoC;
using Robust.Shared.Localization;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Content.Server.GameObjects.Components.MachineLinking
{
[RegisterComponent]
public class SignalReceiverComponent : Component, IInteractUsing
{
[Dependency] private readonly IMapManager _mapManager = default!;
public override string Name => "SignalReceiver";
private List<SignalTransmitterComponent> _transmitters;
public override void Initialize()
{
base.Initialize();
_transmitters = new List<SignalTransmitterComponent>();
}
public void DistributeSignal(SignalState state)
{
foreach (var comp in Owner.GetAllComponents<ISignalReceiver>())
{
comp.TriggerSignal(state);
}
}
public void Subscribe(SignalTransmitterComponent transmitter)
{
if (_transmitters.Contains(transmitter))
{
return;
}
transmitter.Subscribe(this);
_transmitters.Add(transmitter);
}
public void Unsubscribe(SignalTransmitterComponent transmitter)
{
transmitter.Unsubscribe(this);
_transmitters.Remove(transmitter);
}
/// <summary>
/// Subscribes/Unsubscribes a transmitter to this component. Returns whether it was successful.
/// </summary>
/// <param name="user"></param>
/// <param name="transmitter"></param>
/// <returns></returns>
public bool Interact(IEntity user, SignalTransmitterComponent transmitter)
{
if (transmitter == null)
{
user.PopupMessage(user, Loc.GetString("Signal not set."));
return false;
}
if (_transmitters.Contains(transmitter))
{
Unsubscribe(transmitter);
Owner.PopupMessage(user, Loc.GetString("Unlinked."));
return true;
}
if (transmitter.Range > 0 && !Owner.Transform.GridPosition.InRange(_mapManager, transmitter.Owner.Transform.GridPosition, transmitter.Range))
{
Owner.PopupMessage(user, Loc.GetString("Out of range."));
return false;
}
Subscribe(transmitter);
Owner.PopupMessage(user, Loc.GetString("Linked!"));
return true;
}
public async Task<bool> InteractUsing(InteractUsingEventArgs eventArgs)
{
if (!eventArgs.Using.TryGetComponent<ToolComponent>(out var tool))
return false;
if (tool.HasQuality(ToolQuality.Multitool)
&& eventArgs.Using.TryGetComponent<SignalLinkerComponent>(out var linker))
{
return Interact(eventArgs.User, linker.Link);
}
return false;
}
protected override void Shutdown()
{
base.Shutdown();
foreach (var transmitter in _transmitters)
{
if (transmitter.Deleted)
{
continue;
}
transmitter.Unsubscribe(this);
}
_transmitters.Clear();
}
}
}

87
Content.Server/GameObjects/Components/MachineLinking/SignalSwitchComponent.cs Normal file
View File

@@ -0,0 +1,87 @@
using Content.Shared.GameObjects.EntitySystems;
using Content.Shared.GameObjects.Verbs;
using Content.Shared.Interfaces.GameObjects.Components;
using Robust.Server.GameObjects;
using Robust.Shared.GameObjects;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Localization;
using Robust.Shared.Serialization;
namespace Content.Server.GameObjects.Components.MachineLinking
{
[RegisterComponent]
public class SignalSwitchComponent : Component, IInteractHand, IActivate
{
public override string Name => "SignalSwitch";
private bool _on;
public override void Initialize()
{
base.Initialize();
UpdateSprite();
}
public override void ExposeData(ObjectSerializer serializer)
{
base.ExposeData(serializer);
serializer.DataField(ref _on, "on", true);
}
public void Activate(ActivateEventArgs eventArgs)
{
TransmitSignal(eventArgs.User);
}
public bool InteractHand(InteractHandEventArgs eventArgs)
{
TransmitSignal(eventArgs.User);
return true;
}
public void TransmitSignal(IEntity user)
{
_on = !_on;
UpdateSprite();
if (!Owner.TryGetComponent<SignalTransmitterComponent>(out var transmitter))
{
return;
}
transmitter.TransmitSignal(user, _on ? SignalState.On : SignalState.Off);
}
private void UpdateSprite()
{
if (Owner.TryGetComponent<SpriteComponent>(out var sprite))
{
sprite.LayerSetState(0, _on ? "on" : "off");
}
}
[Verb]
private sealed class ToggleSwitchVerb : Verb<SignalSwitchComponent>
{
protected override void Activate(IEntity user, SignalSwitchComponent component)
{
component.TransmitSignal(user);
}
protected override void GetData(IEntity user, SignalSwitchComponent component, VerbData data)
{
if (!ActionBlockerSystem.CanInteract(user))
{
data.Visibility = VerbVisibility.Invisible;
return;
}
data.Text = Loc.GetString("Toggle Switch");
data.Visibility = VerbVisibility.Visible;
}
}
}
}

166
Content.Server/GameObjects/Components/MachineLinking/SignalTransmitterComponent.cs Normal file
View File

@@ -0,0 +1,166 @@
using Content.Server.GameObjects.Components.Interactable;
using Content.Shared.GameObjects.Components.Interactable;
using Content.Shared.Interfaces;
using Content.Shared.Interfaces.GameObjects.Components;
using Robust.Shared.GameObjects;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.Interfaces.Map;
using Robust.Shared.IoC;
using Robust.Shared.Localization;
using Robust.Shared.Serialization;
using Robust.Shared.ViewVariables;
using System.Collections.Generic;
using System.Threading.Tasks;
namespace Content.Server.GameObjects.Components.MachineLinking
{
[RegisterComponent]
public class SignalTransmitterComponent : Component, IInteractUsing
{
[Dependency] private readonly IMapManager _mapManager = default!;
[Dependency] private readonly IEntityManager _entityManager = default!;
public override string Name => "SignalTransmitter";
private List<SignalReceiverComponent> _unresolvedReceivers;
private List<SignalReceiverComponent> _receivers;
[ViewVariables] private float _range;
/// <summary>
/// 0 is unlimited range
/// </summary>
public float Range { get => _range; private set => _range = value; }
public override void Initialize()
{
base.Initialize();
_receivers = new List<SignalReceiverComponent>();
if (_unresolvedReceivers != null)
{
foreach (var receiver in _unresolvedReceivers)
{
receiver.Subscribe(this);
}
_unresolvedReceivers = null;
}
}
public override void ExposeData(ObjectSerializer serializer)
{
base.ExposeData(serializer);
serializer.DataField(ref _range, "range", 10);
if (serializer.Reading)
{
if (!serializer.TryReadDataField("signalReceivers", out List<EntityUid> entityUids))
{
return;
}
_unresolvedReceivers = new List<SignalReceiverComponent>();
foreach (var entityUid in entityUids)
{
if (!_entityManager.TryGetEntity(entityUid, out var entity)
|| !entity.TryGetComponent<SignalReceiverComponent>(out var receiver))
{
continue;
}
_unresolvedReceivers.Add(receiver);
}
}
else if (serializer.Writing)
{
var entityList = new List<EntityUid>();
foreach (var receiver in _receivers)
{
if (receiver.Deleted)
{
continue;
}
entityList.Add(receiver.Owner.Uid);
}
serializer.DataWriteFunction("signalReceivers", null, () => entityList);
}
}
public bool TransmitSignal(IEntity user, SignalState state)
{
if (_receivers.Count == 0)
{
Owner.PopupMessage(user, Loc.GetString("No receivers connected."));
return false;
}
foreach (var receiver in _receivers)
{
if (Range > 0 && !Owner.Transform.GridPosition.InRange(_mapManager, receiver.Owner.Transform.GridPosition, Range))
{
continue;
}
receiver.DistributeSignal(state);
}
return true;
}
public void Subscribe(SignalReceiverComponent receiver)
{
if (_receivers.Contains(receiver))
{
return;
}
_receivers.Add(receiver);
}
public void Unsubscribe(SignalReceiverComponent receiver)
{
_receivers.Remove(receiver);
}
public SignalTransmitterComponent GetSignal(IEntity user)
{
if (user != null)
{
Owner.PopupMessage(user, Loc.GetString("Signal fetched."));
}
return this;
}
public async Task<bool> InteractUsing(InteractUsingEventArgs eventArgs)
{
if (!eventArgs.Using.TryGetComponent<ToolComponent>(out var tool))
return false;
if (tool.HasQuality(ToolQuality.Multitool)
&& eventArgs.Using.TryGetComponent<SignalLinkerComponent>(out var linker))
{
linker.Link = GetSignal(eventArgs.User);
}
return false;
}
protected override void Shutdown()
{
base.Shutdown();
foreach (var receiver in _receivers)
{
if (receiver.Deleted)
{
continue;
}
receiver.Unsubscribe(this);
}
_receivers.Clear();
}
}
}

35
Content.Server/GameObjects/Components/Power/ApcNetComponents/PowerReceiverUsers/PoweredLightComponent.cs
View File

@@ -21,6 +21,8 @@ using Robust.Shared.IoC;
using Robust.Shared.Localization;
using Robust.Shared.Serialization;
using Robust.Shared.ViewVariables;
using Content.Server.GameObjects.Components.MachineLinking;
using Content.Shared.Interfaces;
namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerReceiverUsers
{
@@ -28,21 +30,17 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
/// Component that represents a wall light. It has a light bulb that can be replaced when broken.
/// </summary>
[RegisterComponent]
public class PoweredLightComponent : Component, IInteractHand, IInteractUsing, IMapInit
public class PoweredLightComponent : Component, IInteractHand, IInteractUsing, IMapInit, ISignalReceiver
{
[Dependency] private IServerNotifyManager _notifyManager = default!;
public override string Name => "PoweredLight";
private static readonly TimeSpan _thunkDelay = TimeSpan.FromSeconds(2);
private TimeSpan _lastThunk;
[ViewVariables] private bool _on;
private LightBulbType BulbType = LightBulbType.Tube;
[ViewVariables] private ContainerSlot _lightBulbContainer;
[ViewVariables]
private LightBulbComponent LightBulb
{
@@ -78,6 +76,23 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
return InsertBulb(eventArgs.Using);
}
public void TriggerSignal(SignalState state)
{
switch (state)
{
case SignalState.On:
_on = true;
break;
case SignalState.Off:
_on = false;
break;
case SignalState.Toggle:
_on = !_on;
break;
}
UpdateLight();
}
public bool InteractHand(InteractHandEventArgs eventArgs)
{
if (!eventArgs.User.TryGetComponent(out IDamageableComponent damageableComponent))
@@ -103,7 +118,7 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
void Burn()
{
_notifyManager.PopupMessage(Owner, eventArgs.User, Loc.GetString("You burn your hand!"));
Owner.PopupMessage(eventArgs.User, Loc.GetString("You burn your hand!"));
damageableComponent.ChangeDamage(DamageType.Heat, 20, false, Owner);
var audioSystem = EntitySystem.Get<AudioSystem>();
audioSystem.PlayFromEntity("/Audio/Effects/lightburn.ogg", Owner);
@@ -158,6 +173,7 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
public override void ExposeData(ObjectSerializer serializer)
{
serializer.DataField(ref BulbType, "bulb", LightBulbType.Tube);
serializer.DataField(ref _on, "on", true);
}
/// <summary>
@@ -189,9 +205,9 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
switch (LightBulb.State)
{
case LightBulbState.Normal:
powerReceiver.Load = LightBulb.PowerUse;
if (powerReceiver.Powered)
if (powerReceiver.Powered && _on)
{
powerReceiver.Load = LightBulb.PowerUse;
sprite.LayerSetState(0, "on");
light.Enabled = true;
light.Color = LightBulb.Color;
@@ -204,6 +220,7 @@ namespace Content.Server.GameObjects.Components.Power.ApcNetComponents.PowerRece
}
else
{
powerReceiver.Load = 0;
sprite.LayerSetState(0, "off");
light.Enabled = false;
}

140
Content.Server/GameObjects/EntitySystems/SignalLinkerSystem.cs Normal file
View File

@@ -0,0 +1,140 @@
using Content.Server.GameObjects.Components.MachineLinking;
using Robust.Server.Interfaces.Console;
using Robust.Server.Interfaces.Player;
using Robust.Shared.GameObjects;
using Robust.Shared.GameObjects.Systems;
using Robust.Shared.Input;
using Robust.Shared.Input.Binding;
using Robust.Shared.Interfaces.GameObjects;
using Robust.Shared.IoC;
using Robust.Shared.Map;
using Robust.Shared.Network;
using Robust.Shared.Players;
using System.Collections.Generic;
namespace Content.Server.GameObjects.EntitySystems
{
public class SignalLinkerSystem : EntitySystem
{
private Dictionary<NetSessionId, SignalTransmitterComponent> _transmitters;
public override void Initialize()
{
base.Initialize();
_transmitters = new Dictionary<NetSessionId, SignalTransmitterComponent>();
}
public void SignalLinkerKeybind(NetSessionId id, bool? enable)
{
if (enable == null)
{
enable = !_transmitters.ContainsKey(id);
}
if (enable == true)
{
if (_transmitters.ContainsKey(id))
{
return;
}
if (_transmitters.Count == 0)
{
CommandBinds.Builder
.Bind(EngineKeyFunctions.Use, new PointerInputCmdHandler(HandleUse))
.Register<SignalLinkerSystem>();
}
_transmitters.Add(id, null);
}
else if (enable == false)
{
if (!_transmitters.ContainsKey(id))
{
return;
}
_transmitters.Remove(id);
if (_transmitters.Count == 0)
{
CommandBinds.Unregister<SignalLinkerSystem>();
}
}
}
private bool HandleUse(ICommonSession session, GridCoordinates coords, EntityUid uid)
{
if (!_transmitters.TryGetValue(session.SessionId, out var signalTransmitter))
{
return false;
}
if (!EntityManager.TryGetEntity(uid, out var entity))
{
return false;
}
if (entity == null)
{
return false;
}
if (entity.TryGetComponent<SignalReceiverComponent>(out var signalReceiver))
{
if (signalReceiver.Interact(session.AttachedEntity, signalTransmitter))
{
return true;
}
}
if (entity.TryGetComponent<SignalTransmitterComponent>(out var transmitter))
{
_transmitters[session.SessionId] = transmitter.GetSignal(session.AttachedEntity);
return true;
}
return false;
}
}
public class SignalLinkerCommand : IClientCommand
{
public string Command => "signallink";
public string Description => "Turns on signal linker mode. Click a transmitter to tune that signal and then click on each receiver to tune them to the transmitter signal.";
public string Help => "signallink (on/off)";
public void Execute(IConsoleShell shell, IPlayerSession player, string[] args)
{
bool? enable = null;
if (args.Length > 0)
{
if (args[0] == "on")
enable = true;
else if (args[0] == "off")
enable = false;
else if (bool.TryParse(args[0], out var boolean))
enable = boolean;
else if (int.TryParse(args[0], out var num))
{
if (num == 1)
enable = true;
else if (num == 0)
enable = false;
}
}
if (!IoCManager.Resolve<IEntitySystemManager>().TryGetEntitySystem<SignalLinkerSystem>(out var system))
{
return;
}
system.SignalLinkerKeybind(player.SessionId, enable);
}
}
}

2
Resources/Groups/groups.yml
View File

@@ -101,6 +101,7 @@
- addaccent
- readyall
- factions
- signallink
CanViewVar: true
CanAdminPlace: true
CanAdminMenu: true
@@ -195,6 +196,7 @@
- addaccent
- readyall
- factions
- signallink
CanViewVar: true
CanAdminPlace: true
CanScript: true

1
Resources/Prototypes/Entities/Constructible/Walls/lighting.yml
View File

@@ -22,6 +22,7 @@
energy: 1.2
offset: "0.5, 0"
color: "#DCDCC6"
- type: SignalReceiver
placement:
snap:
- Wallmount

41
Resources/Prototypes/Entities/Constructible/Walls/linking.yml Normal file
View File

@@ -0,0 +1,41 @@
- type: entity
id: SignalSwitch
name: "signal switch"
components:
- type: Clickable
bounds:
all: -0.25,-0.375,0.25,0.375
- type: InteractionOutline
- type: Collidable
- type: Sprite
sprite: Constructible/Linking/switch.rsi
state: on
- type: Icon
sprite: Constructible/Linking/switch.rsi
state: on
- type: SignalSwitch
- type: SignalTransmitter
placement:
snap:
- Wallmount
- type: entity
id: SignalButton
name: "signal button"
components:
- type: Clickable
bounds:
all: -0.25,-0.375,0.25,0.375
- type: InteractionOutline
- type: Collidable
- type: Sprite
sprite: Constructible/Linking/switch.rsi
state: dead
- type: Icon
sprite: Constructible/Linking/switch.rsi
state: dead
- type: SignalButton
- type: SignalTransmitter
placement:
snap:
- Wallmount

1
Resources/Prototypes/Entities/Objects/Tools/tools.yml
View File

@@ -185,6 +185,7 @@
- type: Tool
qualities:
- Multitool
- type: SignalLinker
- type: entity
name: jaws of life

BIN
Resources/Textures/Constructible/Linking/switch.rsi/dead.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 137 B

44
Resources/Textures/Constructible/Linking/switch.rsi/meta.json Normal file
View File

@@ -0,0 +1,44 @@
{
"version": 1,
"size": {
"x": 32,
"y": 32
},
"license": "CC-BY-SA-3.0",
"copyright": "Taken from https://github.com/tgstation/tgstation/commit/2f127f8b95220226cdd5be356723f3b849c53acf",
"states": [
{
"name": "on",
"select": [],
"flags": {},
"directions": 1,
"delays": [
[
1
]
]
},
{
"name": "off",
"select": [],
"flags": {},
"directions": 1,
"delays": [
[
1
]
]
},
{
"name": "dead",
"select": [],
"flags": {},
"directions": 1,
"delays": [
[
1
]
]
}
]
}

BIN
Resources/Textures/Constructible/Linking/switch.rsi/off.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 137 B

BIN
Resources/Textures/Constructible/Linking/switch.rsi/on.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 137 B