Cinka/OldThink
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Add multi-layer in-hand and clothing support (#6740)

Browse Source
This commit is contained in:
Leon Friedrich
2022-03-02 12:29:42 +13:00
committed by GitHub
parent d088f0f02c
commit c4c238bda9
17 changed files with 529 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

60
Content.Shared/Clothing/ClothingEvents.cs Normal file
View File

@@ -0,0 +1,60 @@
using System.Collections.Generic;
using Robust.Shared.GameObjects;
using static Robust.Shared.GameObjects.SharedSpriteComponent;
namespace Content.Shared.Clothing;
/// <summary>
/// Raised directed at a piece of clothing to get the set of layers to show on the wearer's sprite
/// </summary>
public class GetEquipmentVisualsEvent : EntityEventArgs
{
/// <summary>
/// Entity that is wearing the item.
/// </summary>
public readonly EntityUid Equipee;
public readonly string Slot;
/// <summary>
/// The layers that will be added to the entity that is wearing this item.
/// </summary>
/// <remarks>
/// Note that the actual ordering of the layers depends on the order in which they are added to this list;
/// </remarks>
public List<(string, PrototypeLayerData)> Layers = new();
public GetEquipmentVisualsEvent(EntityUid equipee, string slot)
{
Equipee = equipee;
Slot = slot;
}
}
/// <summary>
/// Raised directed at a piece of clothing after its visuals have been updated.
/// </summary>
/// <remarks>
/// Useful for systems/components that modify the visual layers that an item adds to a player. (e.g. RGB memes)
/// </remarks>
public class EquipmentVisualsUpdatedEvent : EntityEventArgs
{
/// <summary>
/// Entity that is wearing the item.
/// </summary>
public readonly EntityUid Equipee;
public readonly string Slot;
/// <summary>
/// The layers that this item is now revealing.
/// </summary>
public HashSet<string> RevealedLayers;
public EquipmentVisualsUpdatedEvent(EntityUid equipee, string slot, HashSet<string> revealedLayers)
{
Equipee = equipee;
Slot = slot;
RevealedLayers = revealedLayers;
}
}

3
Content.Shared/Hands/Components/HandVirtualItemComponent.cs
View File

@@ -1,4 +1,5 @@
using System;
using Content.Shared.Item;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameStates;
@@ -40,7 +41,7 @@ namespace Content.Shared.Hands.Components
// update hands GUI with new entity.
if (Owner.TryGetContainer(out var containter))
EntitySystem.Get<SharedHandsSystem>().UpdateHandVisuals(containter.Owner);
EntitySystem.Get<SharedItemSystem>().VisualsChanged(Owner);
}
[Serializable, NetSerializable]

44
Content.Shared/Hands/Components/SharedHandsComponent.cs
View File

@@ -3,8 +3,6 @@ using System.Collections.Generic;
using System.Diagnostics.CodeAnalysis;
using System.Linq;
using Content.Shared.ActionBlocker;
using Content.Shared.Administration.Logs;
using Content.Shared.Database;
using Content.Shared.Interaction;
using Content.Shared.Item;
using Robust.Shared.Containers;
@@ -18,6 +16,7 @@ using Robust.Shared.Physics;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.ViewVariables;
using static Robust.Shared.GameObjects.SharedSpriteComponent;
namespace Content.Shared.Hands.Components
{
@@ -709,47 +708,6 @@ namespace Content.Shared.Hands.Components
}
}
#region visualizerData
[Serializable, NetSerializable]
public enum HandsVisuals : byte
{
VisualState
}
[Serializable, NetSerializable]
public sealed class HandsVisualState : ICloneable
{
public List<HandVisualState> Hands { get; } = new();
public HandsVisualState(List<HandVisualState> hands)
{
Hands = hands;
}
public object Clone()
{
return new HandsVisualState(new List<HandVisualState>(Hands));
}
}
[Serializable, NetSerializable]
public struct HandVisualState
{
public string RsiPath { get; }
public string? EquippedPrefix { get; }
public HandLocation Location { get; }
public Color Color { get; }
public HandVisualState(string rsiPath, string? equippedPrefix, HandLocation location, Color color)
{
RsiPath = rsiPath;
EquippedPrefix = equippedPrefix;
Location = location;
Color = color;
}
}
#endregion
[Serializable, NetSerializable]
public sealed class Hand
{

54
Content.Shared/Hands/HandEvents.cs
View File

@@ -1,13 +1,67 @@
using System;
using System.Collections.Generic;
using Content.Shared.Hands.Components;
using JetBrains.Annotations;
using Robust.Shared.GameObjects;
using Robust.Shared.Map;
using Robust.Shared.Maths;
using Robust.Shared.Serialization;
using static Robust.Shared.GameObjects.SharedSpriteComponent;
namespace Content.Shared.Hands
{
/// <summary>
/// Raised directed at an item that needs to update its in-hand sprites/layers.
/// </summary>
public class GetInhandVisualsEvent : EntityEventArgs
{
/// <summary>
/// Entity that owns the hand holding the item.
/// </summary>
public readonly EntityUid User;
public readonly HandLocation Location;
/// <summary>
/// The layers that will be added to the entity that is holding this item.
/// </summary>
/// <remarks>
/// Note that the actual ordering of the layers depends on the order in which they are added to this list;
/// </remarks>
public List<(string, PrototypeLayerData)> Layers = new();
public GetInhandVisualsEvent(EntityUid user, HandLocation location)
{
User = user;
Location = location;
}
}
/// <summary>
/// Raised directed at an item after its visuals have been updated.
/// </summary>
/// <remarks>
/// Useful for systems/components that modify the visual layers that an item adds to a player. (e.g. RGB memes)
/// </remarks>
public class HeldVisualsUpdatedEvent : EntityEventArgs
{
/// <summary>
/// Entity that is holding the item.
/// </summary>
public readonly EntityUid User;
/// <summary>
/// The layers that this item is now revealing.
/// </summary>
public HashSet<string> RevealedLayers;
public HeldVisualsUpdatedEvent(EntityUid user, HashSet<string> revealedLayers)
{
User = user;
RevealedLayers = revealedLayers;
}
}
/// <summary>
/// Raised when an entity item in a hand is deselected.
/// </summary>

46
Content.Shared/Hands/SharedHandsSystem.cs
View File

@@ -2,7 +2,6 @@ using Content.Shared.Administration.Logs;
using Content.Shared.Database;
using Content.Shared.Hands.Components;
using Content.Shared.Input;
using Content.Shared.Item;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.Input.Binding;
@@ -11,7 +10,6 @@ using Robust.Shared.Log;
using Robust.Shared.Map;
using Robust.Shared.Maths;
using Robust.Shared.Players;
using System.Collections.Generic;
namespace Content.Shared.Hands
{
@@ -25,8 +23,7 @@ namespace Content.Shared.Hands
SubscribeAllEvent<RequestSetHandEvent>(HandleSetHand);
SubscribeLocalEvent<SharedHandsComponent, EntRemovedFromContainerMessage>(HandleContainerRemoved);
SubscribeLocalEvent<SharedHandsComponent, EntInsertedIntoContainerMessage>(HandleContainerModified);
SubscribeLocalEvent<SharedHandsComponent, ItemPrefixChangeEvent>(OnPrefixChanged);
SubscribeLocalEvent<SharedHandsComponent, EntInsertedIntoContainerMessage>(HandleContainerInserted);
CommandBinds.Builder
.Bind(ContentKeyFunctions.Drop, new PointerInputCmdHandler(DropPressed))
@@ -34,15 +31,6 @@ namespace Content.Shared.Hands
.Register<SharedHandsSystem>();
}
private void OnPrefixChanged(EntityUid uid, SharedHandsComponent component, ItemPrefixChangeEvent args)
{
// update hands visuals if this item is in a hand (rather then inventory or other container).
if (component.HasHand(args.ContainerId))
{
UpdateHandVisuals(uid, component);
}
}
public override void Shutdown()
{
base.Shutdown();
@@ -141,43 +129,25 @@ namespace Content.Shared.Hands
public abstract void PickupAnimation(EntityUid item, EntityCoordinates initialPosition, Vector2 finalPosition,
EntityUid? exclude);
#endregion
protected virtual void HandleContainerRemoved(EntityUid uid, SharedHandsComponent component, ContainerModifiedMessage args)
{
HandleContainerModified(uid, component, args);
}
#endregion
#region visuals
private void HandleContainerModified(EntityUid uid, SharedHandsComponent hands, ContainerModifiedMessage args)
protected virtual void HandleContainerModified(EntityUid uid, SharedHandsComponent hands, ContainerModifiedMessage args)
{
UpdateHandVisuals(uid, hands);
// client updates hand visuals here.
}
/// <summary>
/// Update the In-Hand sprites
/// </summary>
public virtual void UpdateHandVisuals(EntityUid uid, SharedHandsComponent? handComp = null, AppearanceComponent? appearance = null)
private void HandleContainerInserted(EntityUid uid, SharedHandsComponent component, EntInsertedIntoContainerMessage args)
{
if (!Resolve(uid, ref handComp, ref appearance, false))
return;
// un-rotate entities. needed for things like directional flashlights
Transform(args.Entity).LocalRotation = 0;
var handsVisuals = new List<HandVisualState>();
foreach (var hand in handComp.Hands)
{
if (hand.HeldEntity == null)
continue;
if (!TryComp(hand.HeldEntity.Value, out SharedItemComponent? item) || item.RsiPath == null)
continue;
var handState = new HandVisualState(item.RsiPath, item.EquippedPrefix, hand.Location, item.Color);
handsVisuals.Add(handState);
}
appearance.SetData(HandsVisuals.VisualState, new HandsVisualState(handsVisuals));
HandleContainerModified(uid, component, args);
}
#endregion
private void HandleSetHand(RequestSetHandEvent msg, EntitySessionEventArgs eventArgs)
{

3
Content.Shared/Inventory/InventorySystem.Equip.cs
View File

@@ -53,6 +53,9 @@ public abstract partial class InventorySystem
if(!TryGetSlot(uid, args.Container.ID, out var slotDef, inventory: component))
return;
// un-rotate entities. needed for things like directional flashlights on hardsuit helmets
Transform(args.Entity).LocalRotation = 0;
var equippedEvent = new DidEquipEvent(uid, args.Entity, slotDef);
RaiseLocalEvent(uid, equippedEvent);

52
Content.Shared/Item/SharedItemComponent.cs
View File

@@ -1,11 +1,10 @@
using System;
using Content.Shared.Hands;
using System.Collections.Generic;
using Content.Shared.Hands.Components;
using Content.Shared.Interaction;
using Content.Shared.Interaction.Helpers;
using Content.Shared.Inventory;
using Content.Shared.Sound;
using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameStates;
using Robust.Shared.IoC;
@@ -13,6 +12,7 @@ using Robust.Shared.Maths;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager.Attributes;
using Robust.Shared.ViewVariables;
using static Robust.Shared.GameObjects.SharedSpriteComponent;
namespace Content.Shared.Item
{
@@ -40,10 +40,18 @@ namespace Content.Shared.Item
[DataField("size")]
private int _size;
[DataField("inhandVisuals")]
public Dictionary<HandLocation, List<PrototypeLayerData>> InhandVisuals = new();
[DataField("clothingVisuals")]
public Dictionary<string, List<PrototypeLayerData>> ClothingVisuals = new();
/// <summary>
/// Part of the state of the sprite shown on the player when this item is in their hands.
/// Part of the state of the sprite shown on the player when this item is in their hands or inventory.
/// </summary>
// todo paul make this update slotvisuals on client on change
/// <remarks>
/// Only used if <see cref="InhandVisuals"/> or <see cref="ClothingVisuals"/> are unspecified.
/// </remarks>
[ViewVariables(VVAccess.ReadWrite)]
public string? EquippedPrefix
{
@@ -51,7 +59,7 @@ namespace Content.Shared.Item
set
{
_equippedPrefix = value;
OnEquippedPrefixChange();
EntitySystem.Get<SharedItemSystem>().VisualsChanged(Owner, this);
Dirty();
}
}
@@ -65,6 +73,7 @@ namespace Content.Shared.Item
[DataField("EquipSound")]
public SoundSpecifier? EquipSound { get; set; } = default!;
// TODO REMOVE. Currently nonfunctional and only used by RGB system. #6253 Fixes this but requires #6252
/// <summary>
/// Color of the sprite shown on the player when this item is in their hands.
/// </summary>
@@ -82,20 +91,11 @@ namespace Content.Shared.Item
private Color _color = Color.White;
/// <summary>
/// Rsi of the sprite shown on the player when this item is in their hands.
/// Rsi of the sprite shown on the player when this item is in their hands. Used to generate a default entry for <see cref="InhandVisuals"/>
/// </summary>
[ViewVariables(VVAccess.ReadWrite)]
public string? RsiPath
{
get => _rsiPath;
set
{
_rsiPath = value;
Dirty();
}
}
[DataField("sprite")]
private string? _rsiPath;
public readonly string? RsiPath;
bool IInteractHand.InteractHand(InteractHandEventArgs eventArgs)
{
@@ -113,12 +113,6 @@ namespace Content.Shared.Item
return hands.TryPickupEntityToActiveHand(Owner, animateUser: true);
}
private void OnEquippedPrefixChange()
{
if (Owner.TryGetContainer(out var container))
_entMan.EventBus.RaiseLocalEvent(container.Owner, new ItemPrefixChangeEvent(Owner, container.ID));
}
public void RemovedFromSlot()
{
if (_entMan.TryGetComponent(Owner, out SharedSpriteComponent component))
@@ -137,29 +131,25 @@ namespace Content.Shared.Item
{
public int Size { get; }
public string? EquippedPrefix { get; }
public Color Color { get; }
public string? RsiPath { get; }
public ItemComponentState(int size, string? equippedPrefix, Color color, string? rsiPath)
public ItemComponentState(int size, string? equippedPrefix)
{
Size = size;
EquippedPrefix = equippedPrefix;
Color = color;
RsiPath = rsiPath;
}
}
/// <summary>
/// Raised when an item's EquippedPrefix is changed. The event is directed at the entity that contains this item, so
/// that it can properly update its sprite/GUI.
/// Raised when an item's visual state is changed. The event is directed at the entity that contains this item, so
/// that it can properly update its hands or inventory sprites and GUI.
/// </summary>
[Serializable, NetSerializable]
public sealed class ItemPrefixChangeEvent : EntityEventArgs
public sealed class VisualsChangedEvent : EntityEventArgs
{
public readonly EntityUid Item;
public readonly string ContainerId;
public ItemPrefixChangeEvent(EntityUid item, string containerId)
public VisualsChangedEvent(EntityUid item, string containerId)
{
Item = item;
ContainerId = containerId;

13
Content.Shared/Item/ItemSystem.cs → Content.Shared/Item/SharedItemSystem.cs
View File

@@ -4,10 +4,11 @@ using Robust.Shared.Containers;
using Robust.Shared.GameObjects;
using Robust.Shared.GameStates;
using Robust.Shared.Localization;
using System;
namespace Content.Shared.Item
{
public sealed class ItemSystem : EntitySystem
public abstract class SharedItemSystem : EntitySystem
{
public override void Initialize()
{
@@ -28,13 +29,11 @@ namespace Content.Shared.Item
component.Size = state.Size;
component.EquippedPrefix = state.EquippedPrefix;
component.Color = state.Color;
component.RsiPath = state.RsiPath;
}
private void OnGetState(EntityUid uid, SharedItemComponent component, ref ComponentGetState args)
{
args.State = new ItemComponentState(component.Size, component.EquippedPrefix, component.Color, component.RsiPath);
args.State = new ItemComponentState(component.Size, component.EquippedPrefix);
}
// Although netsync is being set to false for items client can still update these
@@ -75,5 +74,11 @@ namespace Content.Shared.Item
args.Verbs.Add(verb);
}
/// <summary>
/// Notifies any entity that is holding or wearing this item that they may need to update their sprite.
/// </summary>
public virtual void VisualsChanged(EntityUid owner, SharedItemComponent? item = null)
{ }
}
}