Update documentation for body system code (#2556)
This commit is contained in:
@@ -5,8 +5,9 @@ namespace Content.Shared.GameObjects.Components.Body.Part.Property
|
||||
{
|
||||
/// <summary>
|
||||
/// Property attachable to a <see cref="IBodyPart"/>.
|
||||
/// For example, this is used to define the speed capabilities of a
|
||||
/// leg. The movement system will look for a LegProperty on all BodyParts.
|
||||
/// For example, this is used to define the speed capabilities of a leg.
|
||||
/// The movement system will look for a <see cref="LegComponent"/> on all
|
||||
/// <see cref="IBodyPart"/>.
|
||||
/// </summary>
|
||||
public abstract class BodyPartPropertyComponent : Component, IBodyPartProperty
|
||||
{
|
||||
|
||||
@@ -3,13 +3,16 @@ using Robust.Shared.Serialization;
|
||||
|
||||
namespace Content.Shared.GameObjects.Components.Body.Part.Property
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines the length of a <see cref="IBodyPart"/>.
|
||||
/// </summary>
|
||||
[RegisterComponent]
|
||||
public class ExtensionComponent : BodyPartPropertyComponent
|
||||
{
|
||||
public override string Name => "Extension";
|
||||
|
||||
/// <summary>
|
||||
/// Current distance (in tiles).
|
||||
/// Current distance in tiles.
|
||||
/// </summary>
|
||||
public float Distance { get; set; }
|
||||
|
||||
|
||||
@@ -3,7 +3,8 @@
|
||||
namespace Content.Shared.GameObjects.Components.Body.Part.Property
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines an entity as being able to pick up items
|
||||
/// Defines a <see cref="IBodyPart"/> as being able to grasp around an entity,
|
||||
/// for example picking up an item.
|
||||
/// </summary>
|
||||
// TODO BODY Implement
|
||||
[RegisterComponent]
|
||||
|
||||
@@ -2,6 +2,9 @@
|
||||
|
||||
namespace Content.Shared.GameObjects.Components.Body.Part.Property
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines a property for a <see cref="IBodyPart"/>.
|
||||
/// </summary>
|
||||
public interface IBodyPartProperty : IComponent
|
||||
{
|
||||
bool Active { get; set; }
|
||||
|
||||
@@ -3,13 +3,16 @@ using Robust.Shared.Serialization;
|
||||
|
||||
namespace Content.Shared.GameObjects.Components.Body.Part.Property
|
||||
{
|
||||
/// <summary>
|
||||
/// Defines the speed at which a <see cref="IBodyPart"/> can move.
|
||||
/// </summary>
|
||||
[RegisterComponent]
|
||||
public class LegComponent : BodyPartPropertyComponent
|
||||
{
|
||||
public override string Name => "Leg";
|
||||
|
||||
/// <summary>
|
||||
/// Speed (in tiles per second).
|
||||
/// Speed in tiles per second.
|
||||
/// </summary>
|
||||
public float Speed { get; set; }
|
||||
|
||||
|
||||
Reference in New Issue
Block a user