improve wording for all PhysX gem tooltips apart from pipeline, fixes 3898

Signed-off-by: greerdv <greerdv@amazon.com>
This commit is contained in:
greerdv
2021-10-14 16:06:13 +01:00
parent 922a991443
commit ec10bb078e
21 changed files with 174 additions and 147 deletions
+22 -17
View File
@@ -37,13 +37,13 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForceWorldSpace>(
"World Space Force", "Applies a force in world space")
"World Space Force", "Applies a force in world space.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Vector3, &ForceWorldSpace::m_direction, "Direction", "Direction of the force in world space")
->DataElement(AZ::Edit::UIHandlers::Vector3, &ForceWorldSpace::m_direction, "Direction", "Direction of the force in world space.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceWorldSpace::m_magnitude, "Magnitude", "Magnitude of the force in world space")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceWorldSpace::m_magnitude, "Magnitude", "Magnitude of the force in world space.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
;
@@ -109,13 +109,13 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForceLocalSpace>(
"Local Space Force", "Applies a force in the volume's local space")
"Local Space Force", "Applies a force in the volume's local space.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Vector3, &ForceLocalSpace::m_direction, "Direction", "Direction of the force in local space")
->DataElement(AZ::Edit::UIHandlers::Vector3, &ForceLocalSpace::m_direction, "Direction", "Direction of the force in local space.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceLocalSpace::m_magnitude, "Magnitude", "Magnitude of the force in local space")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceLocalSpace::m_magnitude, "Magnitude", "Magnitude of the force in local space.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
;
@@ -179,10 +179,10 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForcePoint>(
"Point Force", "Applies a force relative to the center of the volume")
"Point Force", "Applies a force directed towards or away from the center of the volume.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Default, &ForcePoint::m_magnitude, "Magnitude", "Magnitude of the point force")
->DataElement(AZ::Edit::UIHandlers::Default, &ForcePoint::m_magnitude, "Magnitude", "Magnitude of the point force.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
;
@@ -242,19 +242,24 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForceSplineFollow>(
"Spline Follow Force", "Applies a force to make objects follow a spline at a given speed")
"Spline Follow Force", "Applies a force to make objects follow a spline at a given speed.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_dampingRatio, "Damping Ratio", "Amount of damping applied to an entity that is moving towards a spline")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_dampingRatio, "Damping Ratio",
"Values below 1 cause the entity to approach the spline faster but lead to overshooting and oscillation, "
"while higher values will cause it to approach more slowly but more smoothly.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionZeroValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxDampingRatio)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_frequency, "Frequency", "Frequency at which an entity moves towards a spline")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_frequency, "Frequency",
"Affects how quickly the entity approaches the spline.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinFrequency)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxFrequency)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_targetSpeed, "Target Speed", "Speed at which entities in the force region move along a spline")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_targetSpeed, "Target Speed",
"Speed at which entities in the force region move along a spline.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionMinValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_lookAhead, "Lookahead", "Distance at which entities look ahead in their path to reach a point on a spline")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSplineFollow::m_lookAhead, "Lookahead",
"Distance at which entities look ahead in their path to reach a point on a spline.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionZeroValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxValue)
;
@@ -393,10 +398,10 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForceSimpleDrag>(
"Simple Drag Force", "Simulates a drag force on entities")
"Simple Drag Force", "Simulates a drag force on entities.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSimpleDrag::m_volumeDensity, "Region Density", "Density of the region")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceSimpleDrag::m_volumeDensity, "Region Density", "Density of the region.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionZeroValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxDensity)
;
@@ -463,10 +468,10 @@ namespace PhysX
if (auto editContext = serializeContext->GetEditContext())
{
editContext->Class<ForceLinearDamping>(
"Linear Damping Force", "Applies an opposite force to the entity's velocity")
"Linear Damping Force", "Applies an opposite force to the entity's velocity.")
->ClassElement(AZ::Edit::ClassElements::EditorData, "")
->Attribute(AZ::Edit::Attributes::AutoExpand, true)
->DataElement(AZ::Edit::UIHandlers::Default, &ForceLinearDamping::m_damping, "Damping", "Amount of damping applied to an opposite force")
->DataElement(AZ::Edit::UIHandlers::Default, &ForceLinearDamping::m_damping, "Damping", "Amount of damping applied to an opposite force.")
->Attribute(AZ::Edit::Attributes::Min, s_forceRegionZeroValue)
->Attribute(AZ::Edit::Attributes::Max, s_forceRegionMaxDamping)
;