Class HeightAboveFloorCondition
Represents a situation where a given plane must be within a certain height off the floor
Inheritance
Implements
Inherited Members
Namespace: Unity.MARS.Conditions
Assembly: Unity.MARS.dll
Syntax
[HelpURL("https://docs.unity3d.com/Packages/com.unity.mars@2.0/manual/ReferenceGuideConditions.html#height-above-floor-condition-heightabovefloorcondition")]
[DisallowMultipleComponent]
[ComponentTooltip("Requires the object be raised above the floor.")]
[MonoBehaviourComponentMenu(typeof(HeightAboveFloorCondition), "Condition/Height Above Floor")]
[CreateFromDataOptions(0, false)]
[MovedFrom("Unity.MARS")]
public class HeightAboveFloorCondition : Condition<float>, ISimulatable, ICondition<float>, ICondition, IConditionBase, IRequiresTraits<float>, IRequiresTraits, ICreateFromDataProperties
IdealHeight
Gets/Sets the "ideal" height from the floor.
Declaration
public float IdealHeight { get; set; }Property Value
| Type | Description |
|---|---|
| float |
RangeFromIdealHeight
Gets/Sets the +/- range from the ideal height.
Declaration
public float RangeFromIdealHeight { get; set; }Property Value
| Type | Description |
|---|---|
| float |
RequireInRange
Gets/Sets the requirement that the height must be within Height +/- RangeFromIdealHeight.
Declaration
public bool RequireInRange { get; set; }Property Value
| Type | Description |
|---|---|
| bool |
Methods
FormatDataString(TraitDataSnapshot)
Formats data into a string that is human-readable and appropriate for the condition
Declaration
public string FormatDataString(TraitDataSnapshot data)Parameters
| Type | Name | Description |
|---|---|---|
| TraitDataSnapshot | data | The data |
Returns
| Type | Description |
|---|---|
| string | The formatted string |
GetConditionRatingForData(TraitDataSnapshot)
Return the rating this condition has for the given data snapshot
Declaration
public float GetConditionRatingForData(TraitDataSnapshot data)Parameters
| Type | Name | Description |
|---|---|---|
| TraitDataSnapshot | data | The data |
Returns
| Type | Description |
|---|---|
| float | The result of the condition's data rate matching method |
GetRequiredTraits()
Get the TraitRequirements that are required by this object
Declaration
public override TraitRequirement[] GetRequiredTraits()Returns
| Type | Description |
|---|---|
| TraitRequirement[] | The required traits |
Overrides
IncludeData(TraitDataSnapshot)
Modifies the properties so that the data is acceptable for this condition
Declaration
public void IncludeData(TraitDataSnapshot data)Parameters
| Type | Name | Description |
|---|---|---|
| TraitDataSnapshot | data | The data that should pass this condition after this method is called |
OptimizeForData(TraitDataSnapshot)
Modifies the properties so that the data is the optimal data for this condition
Declaration
public void OptimizeForData(TraitDataSnapshot data)Parameters
| Type | Name | Description |
|---|---|---|
| TraitDataSnapshot | data | The data that should be optimal for the condition after this method is called |
RateDataMatch(ref float)
Describe how well a given piece of data matches a condition. 0 means the match is unacceptable, 1 means a perfect match
Declaration
public override float RateDataMatch(ref float height)Parameters
| Type | Name | Description |
|---|---|---|
| float | height |
Returns
| Type | Description |
|---|---|
| float | A number from 0 to 1 indicating how well a piece of data watches this condition |