100 lines
4.1 KiB
C#
100 lines
4.1 KiB
C#
// Only unused on .NET Core due to KeyValuePair.Deconstruct
|
|
// ReSharper disable once RedundantUsingDirective
|
|
using Robust.Shared.Utility;
|
|
using System;
|
|
using JetBrains.Annotations;
|
|
using Robust.Shared.Interfaces.GameObjects;
|
|
|
|
namespace Content.Shared.GameObjects
|
|
{
|
|
/// <summary>
|
|
/// A verb is an action in the right click menu of an entity.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// To add a verb to an entity, define it as a nested class inside the owning component,
|
|
/// and mark it with <see cref="VerbAttribute"/>
|
|
/// </remarks>
|
|
[UsedImplicitly]
|
|
public abstract class Verb
|
|
{
|
|
/// <summary>
|
|
/// If true, this verb requires the user to be inside within
|
|
/// <see cref="VerbUtility.InteractionRange"/> meters from the entity on which this verb resides.
|
|
/// </summary>
|
|
public virtual bool RequireInteractionRange => true;
|
|
|
|
/// <summary>
|
|
/// Gets the visible verb data for the user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Implementations should write into <paramref name="data"/> to return their data.
|
|
/// </remarks>
|
|
/// <param name="user">The entity of the user opening this menu.</param>
|
|
/// <param name="component">The component instance for which this verb is being loaded.</param>
|
|
/// <param name="data">The data that must be filled into.</param>
|
|
protected abstract void GetData(IEntity user, IComponent component, VerbData data);
|
|
|
|
/// <summary>
|
|
/// Invoked when this verb is activated from the right click menu.
|
|
/// </summary>
|
|
/// <param name="user">The entity of the user opening this menu.</param>
|
|
/// <param name="component">The component instance for which this verb is being loaded.</param>
|
|
public abstract void Activate(IEntity user, IComponent component);
|
|
|
|
public VerbData GetData(IEntity user, IComponent component)
|
|
{
|
|
var data = new VerbData();
|
|
GetData(user, component, data);
|
|
return data;
|
|
}
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
/// <summary>
|
|
/// Sub class of <see cref="T:Content.Shared.GameObjects.Verb" /> that works on a specific type of component,
|
|
/// to reduce casting boiler plate for implementations.
|
|
/// </summary>
|
|
/// <typeparam name="T">The type of component that this verb will run on.</typeparam>
|
|
public abstract class Verb<T> : Verb where T : IComponent
|
|
{
|
|
/// <summary>
|
|
/// Gets the visible verb data for the user.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// Implementations should write into <paramref name="data"/> to return their data.
|
|
/// </remarks>
|
|
/// <param name="user">The entity of the user opening this menu.</param>
|
|
/// <param name="component">The component instance for which this verb is being loaded.</param>
|
|
/// <param name="data">The data that must be filled into.</param>
|
|
protected abstract void GetData(IEntity user, T component, VerbData data);
|
|
|
|
/// <summary>
|
|
/// Invoked when this verb is activated from the right click menu.
|
|
/// </summary>
|
|
/// <param name="user">The entity of the user opening this menu.</param>
|
|
/// <param name="component">The component instance for which this verb is being loaded.</param>
|
|
protected abstract void Activate(IEntity user, T component);
|
|
|
|
protected sealed override void GetData(IEntity user, IComponent component, VerbData data)
|
|
{
|
|
GetData(user, (T) component, data);
|
|
}
|
|
|
|
/// <inheritdoc />
|
|
public sealed override void Activate(IEntity user, IComponent component)
|
|
{
|
|
Activate(user, (T) component);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// This attribute should be used on <see cref="Verb"/> implementations nested inside component classes,
|
|
/// so that they're automatically detected.
|
|
/// </summary>
|
|
[AttributeUsage(AttributeTargets.Class, Inherited = false)]
|
|
[MeansImplicitUse]
|
|
public sealed class VerbAttribute : Attribute
|
|
{
|
|
}
|
|
}
|