GoaLitiuM/FlaxEngine
1
0
Fork 0
Code Issues Pull Requests Actions 7 Packages Projects Releases Wiki Activity

Improve various doc comments to be more usable as tooltips in Editor

Browse Source
This commit is contained in:
Wojtek Figat
2023-11-07 00:57:18 +01:00
parent 87a9dedba4
commit 6648481d12
3 changed files with 28 additions and 94 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Source/Engine/Physics/Colliders/Collider.h
View File

@@ -35,11 +35,8 @@ public:
void* GetPhysicsShape() const;
/// <summary>
/// Gets the 'IsTrigger' flag.
/// Gets the 'IsTrigger' flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter and OnTriggerExit message when a rigidbody enters or exits the trigger volume.
/// </summary>
/// <remarks>
/// A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(0), DefaultValue(false), EditorDisplay(\"Collider\")")
FORCE_INLINE bool GetIsTrigger() const
{
@@ -47,11 +44,8 @@ public:
}
/// <summary>
/// Sets the `IsTrigger` flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// Sets the `IsTrigger` flag. A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter and OnTriggerExit message when a rigidbody enters or exits the trigger volume.
/// </summary>
/// <remarks>
/// A trigger doesn't register a collision with an incoming Rigidbody. Instead, it sends OnTriggerEnter, OnTriggerExit and OnTriggerStay message when a rigidbody enters or exits the trigger volume.
/// </remarks>
API_PROPERTY() void SetIsTrigger(bool value);
/// <summary>
@@ -69,11 +63,8 @@ public:
API_PROPERTY() void SetCenter(const Vector3& value);
/// <summary>
/// Gets the contact offset.
/// Gets the contact offset. Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.
/// </summary>
/// <remarks>
/// Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.
/// </remarks>
API_PROPERTY(Attributes="EditorOrder(1), DefaultValue(2.0f), Limit(0, 100), EditorDisplay(\"Collider\")")
FORCE_INLINE float GetContactOffset() const
{
@@ -81,11 +72,8 @@ public:
}
/// <summary>
/// Sets the contact offset.
/// Sets the contact offset. Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.
/// </summary>
/// <remarks>
/// Colliders whose distance is less than the sum of their ContactOffset values will generate contacts. The contact offset must be positive. Contact offset allows the collision detection system to predictively enforce the contact constraint even when the objects are slightly separated.
/// </remarks>
API_PROPERTY() void SetContactOffset(float value);
/// <summary>