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

Add support for multi-layer in-hand and clothing sprites (#6252)

Browse Source
This commit is contained in:
Leon Friedrich
2022-02-07 16:37:57 +13:00
committed by GitHub
parent aad52dfd35
commit 470e4f8bdc
17 changed files with 529 additions and 262 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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)
{
@@ -116,12 +116,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))
@@ -140,29 +134,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 class ItemPrefixChangeEvent : EntityEventArgs
public 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 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);
}
private void OnUnequipped(EntityUid uid, SharedSpriteComponent component, GotUnequippedEvent args)
@@ -70,5 +69,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)
{ }
}
}