Update documentation for body system code (#2556)
This commit is contained in:
@@ -7,16 +7,46 @@ namespace Content.Shared.GameObjects.Components.Body.Part
|
||||
{
|
||||
public static class BodyPartExtensions
|
||||
{
|
||||
/// <summary>
|
||||
/// Checks if the given <see cref="IBodyPart"/> has the specified property.
|
||||
/// </summary>
|
||||
/// <param name="part">The <see cref="IBodyPart"/> to check in.</param>
|
||||
/// <param name="type">
|
||||
/// The type of <see cref="IBodyPartProperty"/> to check for.
|
||||
/// </param>
|
||||
/// <returns>true if found, false otherwise.</returns>
|
||||
public static bool HasProperty(this IBodyPart part, Type type)
|
||||
{
|
||||
return part.Owner.HasComponent(type);
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Checks if the given <see cref="IBodyPart"/> has the specified property.
|
||||
/// </summary>
|
||||
/// <param name="part">The <see cref="IBodyPart"/> to check in.</param>
|
||||
/// <typeparam name="T">
|
||||
/// The type of <see cref="IBodyPartProperty"/> to check for.
|
||||
/// </typeparam>
|
||||
/// <returns>true if found, false otherwise.</returns>
|
||||
public static bool HasProperty<T>(this IBodyPart part) where T : class, IBodyPartProperty
|
||||
{
|
||||
return part.HasProperty(typeof(T));
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to retrieve the <see cref="IBodyPartProperty"/> with the
|
||||
/// specified type.
|
||||
/// </summary>
|
||||
/// <param name="part">The <see cref="IBodyPart"/> to search in.</param>
|
||||
/// <param name="type">
|
||||
/// The type of <see cref="IBodyPartProperty"/> to search for.
|
||||
/// </param>
|
||||
/// <param name="property">
|
||||
/// The property, if it was found. Null otherwise.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// true if a component with the specified type was found, false otherwise.
|
||||
/// </returns>
|
||||
public static bool TryGetProperty(this IBodyPart part, Type type,
|
||||
[NotNullWhen(true)] out IBodyPartProperty? property)
|
||||
{
|
||||
@@ -29,6 +59,20 @@ namespace Content.Shared.GameObjects.Components.Body.Part
|
||||
return (property = component as IBodyPartProperty) != null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Tries to retrieve the <see cref="IBodyPartProperty"/> with the
|
||||
/// specified type.
|
||||
/// </summary>
|
||||
/// <param name="part">The <see cref="IBodyPart"/> to search in.</param>
|
||||
/// <typeparam name="T">
|
||||
/// The type of <see cref="IBodyPartProperty"/> to search for.
|
||||
/// </typeparam>
|
||||
/// <param name="property">
|
||||
/// The property, if it was found. Null otherwise.
|
||||
/// </param>
|
||||
/// <returns>
|
||||
/// true if a component with the specified type was found, false otherwise.
|
||||
/// </returns>
|
||||
public static bool TryGetProperty<T>(this IBodyPart part, [NotNullWhen(true)] out T? property) where T : class, IBodyPartProperty
|
||||
{
|
||||
return part.Owner.TryGetComponent(out property);
|
||||
|
||||
Reference in New Issue
Block a user