#nullable enable
using Content.Shared.Interfaces;
using Robust.Shared.IoC;
using Robust.Shared.Log;
using Robust.Shared.Prototypes;
using Robust.Shared.Serialization;
using Robust.Shared.Serialization.Manager.Attributes;
namespace Content.Shared.Actions
{
///
/// An action which is granted to an entity via an item (such as toggling a flashlight).
///
[Prototype("itemAction")]
[DataDefinition]
public class ItemActionPrototype : BaseActionPrototype, ISerializationHooks
{
///
/// Type of item action, no 2 itemAction prototypes should have the same one.
///
[DataField("actionType")]
public ItemActionType ActionType { get; private set; } = ItemActionType.Error;
///
[DataField("iconStyle")]
public ItemActionIconStyle IconStyle { get; private set; } = ItemActionIconStyle.BigItem;
///
/// The IInstantItemAction that should be invoked when performing this
/// action. Null if this is not an Instant ActionBehaviorType.
/// Will be null on client side if the behavior is not in Content.Client.
///
public IInstantItemAction InstantAction { get; private set; } = default!;
///
/// The IToggleItemAction that should be invoked when performing this
/// action. Null if this is not a Toggle ActionBehaviorType.
/// Will be null on client side if the behavior is not in Content.Client.
///
public IToggleItemAction ToggleAction { get; private set; } = default!;
///
/// The ITargetEntityItemAction that should be invoked when performing this
/// action. Null if this is not a TargetEntity ActionBehaviorType.
/// Will be null on client side if the behavior is not in Content.Client.
///
public ITargetEntityItemAction TargetEntityAction { get; private set; } = default!;
///
/// The ITargetPointItemAction that should be invoked when performing this
/// action. Null if this is not a TargetPoint ActionBehaviorType.
/// Will be null on client side if the behavior is not in Content.Client.
///
public ITargetPointItemAction TargetPointAction { get; private set; } = default!;
[DataField("behavior", readOnly: true, serverOnly: true)]
public IItemActionBehavior? ItemActionBehavior { get; private set; }
public override string ID => ActionType.ToString();
public override void AfterDeserialization()
{
base.AfterDeserialization();
if (ActionType == ItemActionType.Error)
{
Logger.ErrorS("action", "missing or invalid actionType for action with name {0}", Name);
}
// TODO: Split this class into server/client after RobustToolbox#1405
if (IoCManager.Resolve().IsClientModule) return;
switch (ItemActionBehavior)
{
case null:
BehaviorType = BehaviorType.None;
Logger.ErrorS("action", "missing or invalid behavior for action with name {0}", Name);
break;
case IInstantItemAction instantAction:
ValidateBehaviorType(BehaviorType.Instant, typeof(IInstantItemAction));
BehaviorType = BehaviorType.Instant;
InstantAction = instantAction;
break;
case IToggleItemAction toggleAction:
ValidateBehaviorType(BehaviorType.Toggle, typeof(IToggleItemAction));
BehaviorType = BehaviorType.Toggle;
ToggleAction = toggleAction;
break;
case ITargetEntityItemAction targetEntity:
ValidateBehaviorType(BehaviorType.TargetEntity, typeof(ITargetEntityItemAction));
BehaviorType = BehaviorType.TargetEntity;
TargetEntityAction = targetEntity;
break;
case ITargetPointItemAction targetPointAction:
ValidateBehaviorType(BehaviorType.TargetPoint, typeof(ITargetPointItemAction));
BehaviorType = BehaviorType.TargetPoint;
TargetPointAction = targetPointAction;
break;
default:
BehaviorType = BehaviorType.None;
Logger.ErrorS("action", "unrecognized behavior type for action with name {0}", Name);
break;
}
}
}
///
/// Determines how the action icon appears in the hotbar for item actions.
///
public enum ItemActionIconStyle : byte
{
///
/// The default - the item icon will be big with a small action icon in the corner
///
BigItem,
///
/// The action icon will be big with a small item icon in the corner
///
BigAction,
///
/// BigAction but no item icon will be shown in the corner.
///
NoItem
}
}