2166958bd0
* AutoCompState + ItemToggle fixes Fix a lot of the comp states that are never actually networked and also cleaned up ItemToggle events a bunch. ItemToggle will still need some future work for lights and sounds. * Also catch these
98 lines
3.1 KiB
C#
98 lines
3.1 KiB
C#
using Robust.Shared.Audio;
|
|
using Robust.Shared.GameStates;
|
|
|
|
namespace Content.Shared.Item.ItemToggle.Components;
|
|
|
|
/// <summary>
|
|
/// Handles generic item toggles, like a welder turning on and off, or an e-sword.
|
|
/// </summary>
|
|
/// <remarks>
|
|
/// If you need extended functionality (e.g. requiring power) then add a new component and use events:
|
|
/// ItemToggleActivateAttemptEvent, ItemToggleDeactivateAttemptEvent or ItemToggleForceToggleEvent.
|
|
/// </remarks>
|
|
[RegisterComponent, NetworkedComponent, AutoGenerateComponentState]
|
|
public sealed partial class ItemToggleComponent : Component
|
|
{
|
|
/// <summary>
|
|
/// The item's toggle state.
|
|
/// </summary>
|
|
[ViewVariables(VVAccess.ReadWrite), DataField, AutoNetworkedField]
|
|
public bool Activated = false;
|
|
|
|
/// <summary>
|
|
/// Whether the item's toggle can be predicted by the client.
|
|
/// </summary>
|
|
/// /// <remarks>
|
|
/// If server-side systems affect the item's toggle, like charge/fuel systems, then the item is not predictable.
|
|
/// </remarks>
|
|
[ViewVariables(VVAccess.ReadWrite), DataField, AutoNetworkedField]
|
|
public bool Predictable = true;
|
|
|
|
/// <summary>
|
|
/// The noise this item makes when it is toggled on.
|
|
/// </summary>
|
|
[ViewVariables(VVAccess.ReadWrite), DataField, AutoNetworkedField]
|
|
public SoundSpecifier? SoundActivate;
|
|
|
|
/// <summary>
|
|
/// The noise this item makes when it is toggled off.
|
|
/// </summary>
|
|
[ViewVariables(VVAccess.ReadWrite), DataField, AutoNetworkedField]
|
|
public SoundSpecifier? SoundDeactivate;
|
|
|
|
/// <summary>
|
|
/// The noise this item makes when it is toggled on.
|
|
/// </summary>
|
|
[ViewVariables(VVAccess.ReadWrite), DataField, AutoNetworkedField]
|
|
public SoundSpecifier? SoundFailToActivate;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Raised directed on an entity when its ItemToggle is attempted to be activated.
|
|
/// </summary>
|
|
[ByRefEvent]
|
|
public record struct ItemToggleActivateAttemptEvent(EntityUid? User)
|
|
{
|
|
public bool Cancelled = false;
|
|
public readonly EntityUid? User = User;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Raised directed on an entity when its ItemToggle is attempted to be deactivated.
|
|
/// </summary>
|
|
[ByRefEvent]
|
|
public record struct ItemToggleDeactivateAttemptEvent(EntityUid? User)
|
|
{
|
|
public bool Cancelled = false;
|
|
public readonly EntityUid? User = User;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Raised directed on an entity any sort of toggle is complete.
|
|
/// </summary>
|
|
[ByRefEvent]
|
|
public readonly record struct ItemToggledEvent(bool Predicted, bool Activated, EntityUid? User)
|
|
{
|
|
public readonly bool Predicted = Predicted;
|
|
public readonly bool Activated = Activated;
|
|
public readonly EntityUid? User = User;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Raised directed on an entity when an itemtoggle is activated.
|
|
/// </summary>
|
|
[ByRefEvent]
|
|
public readonly record struct ItemToggleActivatedEvent(EntityUid? User)
|
|
{
|
|
public readonly EntityUid? User = User;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Raised directed on an entity when an itemtoggle is deactivated.
|
|
/// </summary>
|
|
[ByRefEvent]
|
|
public readonly record struct ItemToggleDeactivatedEvent(EntityUid? User)
|
|
{
|
|
public readonly EntityUid? User = User;
|
|
}
|